From a3a9097034d73b8088cb68ab7063b74ff937e4fa Mon Sep 17 00:00:00 2001 From: rdlabo Date: Sat, 22 Aug 2026 18:42:58 +0900 Subject: [PATCH 1/2] refactor: move docs app into Angular projects --- .github/workflows/ci.yml | 4 +- .prettierignore | 16 +-- .prettierrc.json | 2 +- AGENTS.md | 40 ++++---- README.md | 40 ++++---- angular.json | 40 ++++---- eslint.config.js | 10 +- package.json | 4 +- {public => projects/docs/public}/404.html | 0 .../public}/assets/brand/apple-touch-icon.png | Bin .../docs/public}/assets/brand/og-card.png | Bin .../docs/public}/assets/brand/og-card.svg | 0 .../docs/public}/assets/brand/rdlabo-logo.svg | 0 .../public}/assets/icon/capacitor-logo.svg | 0 {public => projects/docs/public}/favicon.ico | Bin {public => projects/docs/public}/ja/404.html | 0 {public => projects/docs/public}/robots.txt | 0 {public => projects/docs/public}/sitemap.xml | 0 .../docs/src}/admob/docs/ja/app-open.md | 0 .../docs/src}/admob/docs/ja/banner.md | 0 .../docs/src}/admob/docs/ja/configuration.md | 0 .../docs/src}/admob/docs/ja/consent.md | 0 .../docs/src}/admob/docs/ja/events.md | 0 .../docs/src}/admob/docs/ja/interstitial.md | 0 .../docs/src}/admob/docs/ja/migration.md | 0 .../docs/src}/admob/docs/ja/readme.md | 0 .../docs/src}/admob/docs/ja/rewarded.md | 0 .../docs/src}/admob/docs/ja/testing.md | 0 .../docs/src}/app/app.config.server.ts | 0 {src => projects/docs/src}/app/app.config.ts | 0 {src => projects/docs/src}/app/app.css | 0 {src => projects/docs/src}/app/app.html | 0 .../docs/src}/app/app.routes.server.ts | 0 .../docs/src}/app/app.routes.spec.ts | 0 {src => projects/docs/src}/app/app.routes.ts | 0 {src => projects/docs/src}/app/app.spec.ts | 0 {src => projects/docs/src}/app/app.ts | 0 .../docs/src}/app/docs/code-panel.spec.ts | 0 .../docs/src}/app/docs/code-panel.ts | 0 .../docs/src}/app/docs/docs-data.ts | 0 .../docs/src}/app/docs/docs-page.ts | 0 .../app/docs/github-stars.service.spec.ts | 0 .../src}/app/docs/github-stars.service.ts | 0 .../docs/src}/app/docs/landing-page.spec.ts | 0 .../docs/src}/app/docs/landing-page.ts | 0 .../docs/src}/app/docs/not-found.spec.ts | 0 .../docs/src}/app/docs/not-found.ts | 0 .../docs/src}/app/docs/plugin-index.spec.ts | 0 .../docs/src}/app/docs/plugin-index.ts | 0 .../docs/src}/app/docs/project-icon.ts | 0 .../docs/src}/app/docs/project.resolver.ts | 0 .../docs/src}/app/docs/safe-html.pipe.ts | 0 .../src}/app/docs/scroll-spy.directive.ts | 0 .../docs/src}/app/docs/scroll-spy.spec.ts | 0 .../docs/src}/app/docs/scroll-spy.ts | 0 .../docs/src}/app/docs/seo.service.spec.ts | 0 .../docs/src}/app/docs/seo.service.ts | 0 .../docs/src}/app/docs/support-page.spec.ts | 0 .../docs/src}/app/docs/support-page.ts | 0 .../generated/project-catalog.generated.ts | 0 .../generated/project-loaders.generated.ts | 0 .../generated/projects/admob.en.generated.ts | 0 .../generated/projects/admob.ja.generated.ts | 20 ++-- .../capacitor-brotherprint.en.generated.ts | 0 .../capacitor-brotherprint.ja.generated.ts | 10 +- .../capacitor-codescanner.en.generated.ts | 0 .../capacitor-codescanner.ja.generated.ts | 4 +- .../projects/capacitor-docgen.en.generated.ts | 2 +- .../projects/capacitor-docgen.ja.generated.ts | 6 +- .../capacitor-printer.en.generated.ts | 0 .../capacitor-printer.ja.generated.ts | 6 +- ...capacitor-screenshot-event.en.generated.ts | 0 ...capacitor-screenshot-event.ja.generated.ts | 4 +- .../eslint-plugin-rules.en.generated.ts | 2 +- .../eslint-plugin-rules.ja.generated.ts | 48 ++++----- .../projects/facebook-login.en.generated.ts | 0 .../projects/facebook-login.ja.generated.ts | 8 +- ...onic-angular-collect-icons.en.generated.ts | 2 +- ...onic-angular-collect-icons.ja.generated.ts | 14 +-- .../ionic-angular-kit.en.generated.ts | 2 +- .../ionic-angular-kit.ja.generated.ts | 12 +-- ...ionic-angular-photo-editor.en.generated.ts | 2 +- ...ionic-angular-photo-editor.ja.generated.ts | 12 +-- ...onic-angular-scroll-header.en.generated.ts | 2 +- ...onic-angular-scroll-header.ja.generated.ts | 10 +- .../ionic-theme-ios26.en.generated.ts | 2 +- .../ionic-theme-ios26.ja.generated.ts | 16 +-- .../projects/ionic-theme-md3.en.generated.ts | 2 +- .../projects/ionic-theme-md3.ja.generated.ts | 10 +- .../ngx-cdk-scroll-strategies.en.generated.ts | 2 +- .../ngx-cdk-scroll-strategies.ja.generated.ts | 12 +-- .../projects/stripe-identity.en.generated.ts | 2 +- .../projects/stripe-identity.ja.generated.ts | 6 +- .../projects/stripe-terminal.en.generated.ts | 2 +- .../projects/stripe-terminal.ja.generated.ts | 10 +- .../generated/projects/stripe.en.generated.ts | 2 +- .../generated/projects/stripe.ja.generated.ts | 24 ++--- .../projects/workers-hono-kit.en.generated.ts | 0 .../projects/workers-hono-kit.ja.generated.ts | 12 +-- .../src}/app/generated/sponsors.generated.ts | 0 {src => projects/docs/src}/app/locale-path.ts | 0 {src => projects/docs/src}/app/site-config.ts | 0 .../capacitor-brotherprint/docs/ja/events.md | 0 .../docs/ja/installation.md | 0 .../capacitor-brotherprint/docs/ja/print.md | 0 .../capacitor-brotherprint/docs/ja/readme.md | 0 .../capacitor-brotherprint/docs/ja/search.md | 0 .../docs/ja/code-scanner.md | 0 .../capacitor-codescanner/docs/ja/readme.md | 0 .../docs/src}/capacitor-docgen/docs/api.md | 0 .../capacitor-docgen/docs/getting-started.md | 0 .../docs/src}/capacitor-docgen/docs/ja/api.md | 0 .../docs/ja/getting-started.md | 0 .../docs/ja/upstream-differences.md | 0 .../docs/upstream-differences.md | 0 .../src}/capacitor-printer/docs/ja/pdf.md | 0 .../src}/capacitor-printer/docs/ja/readme.md | 0 .../src}/capacitor-printer/docs/ja/web.md | 0 .../docs/ja/readme.md | 0 .../docs/ja/screenshot-event.md | 0 .../docs/src}/eslint-plugin-rules/docs/api.md | 0 .../eslint-plugin-rules/docs/configuration.md | 0 .../docs/getting-started.md | 0 .../src}/eslint-plugin-rules/docs/ja/api.md | 0 .../docs/ja/configuration.md | 0 .../docs/ja/getting-started.md | 0 .../eslint-plugin-rules/docs/ja/migration.md | 0 .../src}/eslint-plugin-rules/docs/ja/rules.md | 0 .../rules/component-property-use-readonly.md | 0 .../docs/ja/rules/deny-constructor-di.md | 0 .../docs/ja/rules/deny-element.md | 0 .../docs/ja/rules/deny-overlay-create.md | 0 .../ja/rules/deny-soft-private-modifier.md | 0 .../ja/rules/implements-ionic-lifecycle.md | 0 .../docs/ja/rules/ionic-attr-type-check.md | 0 .../no-component-method-except-lifecycle.md | 0 .../ja/rules/no-component-writable-signal.md | 0 .../docs/ja/rules/no-reactive-forms.md | 0 .../docs/ja/rules/no-template-driven-forms.md | 0 .../docs/ja/rules/prefer-disable-handler.md | 0 .../docs/ja/rules/prefer-ionic-standalone.md | 0 .../docs/ja/rules/prefer-modal-launcher.md | 0 .../docs/ja/rules/require-ion-item-group.md | 0 .../docs/ja/rules/require-viewmodel.md | 0 .../docs/ja/rules/restrict-try-block.md | 0 .../ja/rules/signal-use-as-signal-template.md | 0 .../docs/ja/rules/signal-use-as-signal.md | 0 .../src}/eslint-plugin-rules/docs/rules.md | 0 .../rules/component-property-use-readonly.md | 0 .../docs/rules/deny-constructor-di.md | 0 .../docs/rules/deny-element.md | 0 .../rules/deny-import-from-ionic-module.md | 0 .../docs/rules/deny-overlay-create.md | 0 .../docs/rules/deny-soft-private-modifier.md | 0 .../docs/rules/implements-ionic-lifecycle.md | 0 .../docs/rules/ionic-attr-type-check.md | 0 .../no-component-method-except-lifecycle.md | 0 .../rules/no-component-writable-signal.md | 0 .../docs/rules/no-reactive-forms.md | 0 .../docs/rules/no-template-driven-forms.md | 0 .../docs/rules/prefer-disable-handler.md | 0 .../docs/rules/prefer-modal-launcher.md | 0 .../docs/rules/require-viewmodel.md | 0 .../docs/rules/restrict-try-block.md | 0 .../rules/signal-use-as-signal-template.md | 0 .../docs/rules/signal-use-as-signal.md | 0 .../src}/facebook-login/docs/ja/app-events.md | 0 .../facebook-login/docs/ja/authentication.md | 0 .../facebook-login/docs/ja/configuration.md | 0 .../src}/facebook-login/docs/ja/readme.md | 0 {src => projects/docs/src}/index.html | 0 .../ionic-angular-collect-icons/docs/api.md | 0 .../ionic-angular-collect-icons/docs/faq.md | 0 .../docs/initialize.md | 0 .../docs/ja/api.md | 0 .../docs/ja/faq.md | 0 .../docs/ja/initialize.md | 0 .../docs/ja/migration.md | 0 .../docs/ja/options.md | 0 .../docs/ja/readme.md | 0 .../docs/ja/usage.md | 0 .../docs/options.md | 0 .../docs/readme.md | 0 .../ionic-angular-collect-icons/docs/usage.md | 0 .../docs/src}/ionic-angular-kit/docs/api.md | 0 .../src}/ionic-angular-kit/docs/auth-http.md | 0 .../ionic-angular-kit/docs/getting-started.md | 0 .../src}/ionic-angular-kit/docs/ja/api.md | 0 .../ionic-angular-kit/docs/ja/auth-http.md | 0 .../docs/ja/getting-started.md | 0 .../docs/ja/offline-realtime.md | 0 .../docs/ja/optional-features.md | 0 .../docs/ja/storage-overlays.md | 0 .../docs/offline-realtime.md | 0 .../docs/optional-features.md | 0 .../docs/storage-overlays.md | 0 .../ionic-angular-photo-editor/docs/api.md | 0 .../ionic-angular-photo-editor/docs/editor.md | 0 .../ionic-angular-photo-editor/docs/ja/api.md | 0 .../docs/ja/editor.md | 0 .../docs/ja/photo-file.md | 0 .../docs/ja/readme.md | 0 .../docs/ja/theme.md | 0 .../docs/ja/viewer.md | 0 .../docs/photo-file.md | 0 .../ionic-angular-photo-editor/docs/readme.md | 0 .../ionic-angular-photo-editor/docs/theme.md | 0 .../ionic-angular-photo-editor/docs/viewer.md | 0 .../ionic-angular-scroll-header/docs/api.md | 0 .../docs/ion-content.md | 0 .../docs/ja/api.md | 0 .../docs/ja/ion-content.md | 0 .../docs/ja/readme.md | 0 .../docs/ja/safe-area.md | 0 .../docs/ja/virtual-scroll.md | 0 .../docs/readme.md | 0 .../docs/safe-area.md | 0 .../docs/virtual-scroll.md | 0 .../docs/src}/ionic-theme-ios26/docs/api.md | 0 .../docs/experimental-animation.md | 0 .../src}/ionic-theme-ios26/docs/features.md | 0 .../src}/ionic-theme-ios26/docs/ios-18.md | 0 .../src}/ionic-theme-ios26/docs/ja/api.md | 0 .../docs/ja/experimental-animation.md | 0 .../ionic-theme-ios26/docs/ja/features.md | 0 .../src}/ionic-theme-ios26/docs/ja/ios-18.md | 0 .../ionic-theme-ios26/docs/ja/migration.md | 0 .../src}/ionic-theme-ios26/docs/ja/readme.md | 0 .../docs/ja/special-markup.md | 0 .../docs/ja/using-ion-item-group.md | 0 .../src}/ionic-theme-ios26/docs/migration.md | 0 .../src}/ionic-theme-ios26/docs/readme.md | 0 .../docs/using-ion-item-group.md | 0 .../docs/src}/ionic-theme-md3/docs/api.md | 0 .../docs/src}/ionic-theme-md3/docs/ja/api.md | 0 .../src}/ionic-theme-md3/docs/ja/migration.md | 0 .../src}/ionic-theme-md3/docs/ja/readme.md | 0 .../ionic-theme-md3/docs/ja/special-markup.md | 0 .../docs/ja/using-ion-item-group.md | 0 .../docs/src}/ionic-theme-md3/docs/readme.md | 0 .../docs/src}/locale/messages.en.xlf | 92 +++++++++--------- .../docs/src}/locale/messages.ja.xlf | 0 {src => projects/docs/src}/main.server.ts | 0 {src => projects/docs/src}/main.ts | 0 .../docs/advanced.md | 0 .../ngx-cdk-scroll-strategies/docs/api.md | 0 .../ngx-cdk-scroll-strategies/docs/faq.md | 0 .../docs/ja/advanced.md | 0 .../ngx-cdk-scroll-strategies/docs/ja/api.md | 0 .../ngx-cdk-scroll-strategies/docs/ja/faq.md | 0 .../docs/ja/readme.md | 0 .../docs/ja/reverse.md | 0 .../docs/ja/simple.md | 0 .../ngx-cdk-scroll-strategies/docs/readme.md | 0 .../ngx-cdk-scroll-strategies/docs/reverse.md | 0 .../ngx-cdk-scroll-strategies/docs/simple.md | 0 {src => projects/docs/src}/server.ts | 0 .../src}/stripe-identity/config/docs.json | 0 .../src}/stripe-identity/config/packages.json | 0 .../docs/src}/stripe-identity/docs/api.md | 0 .../stripe-identity/docs/configuration.md | 0 .../docs/identity-verification-sheet.md | 0 .../identity-verification-sheet/example.ts.md | 0 .../docs/src}/stripe-identity/docs/ja/api.md | 0 .../stripe-identity/docs/ja/configuration.md | 0 .../docs/ja/identity-verification-sheet.md | 0 .../src}/stripe-terminal/config/docs.json | 0 .../src}/stripe-terminal/config/packages.json | 0 .../docs/src}/stripe-terminal/docs/api.md | 0 .../stripe-terminal/docs/collect-a-payment.md | 0 .../collect-a-payment/collect-payment.ts.md | 0 .../collect-a-payment/connection-token.ts.md | 0 .../stripe-terminal/docs/configuration.md | 0 .../docs/src}/stripe-terminal/docs/ja/api.md | 0 .../docs/ja/collect-a-payment.md | 0 .../stripe-terminal/docs/ja/configuration.md | 0 .../docs/ja/reader-lifecycle.md | 0 .../stripe-terminal/docs/ja/tap-to-pay.md | 0 .../stripe-terminal/docs/reader-lifecycle.md | 0 .../reader-lifecycle/reader-lifecycle.ts.md | 0 .../src}/stripe-terminal/docs/tap-to-pay.md | 0 .../docs/tap-to-pay/tap-to-pay.ts.md | 0 .../src}/stripe/assets/capacitor-image.png | Bin .../docs/src}/stripe/assets/doctr.svg | 0 .../docs/src}/stripe/assets/sunset.png | Bin .../docs/src}/stripe/assets/vegasbuilt.svg | 0 .../docs/src}/stripe/config/docs.json | 0 .../docs/src}/stripe/config/packages.json | 0 .../docs/src}/stripe/docs/angular.md | 0 {src => projects/docs/src}/stripe/docs/api.md | 0 .../docs/src}/stripe/docs/apple-pay.md | 0 .../stripe/docs/apple-pay/apple-pay.ts.md | 0 .../docs/src}/stripe/docs/configuration.md | 0 .../docs/src}/stripe/docs/google-pay.md | 0 .../docs/google-pay/android-manifest.xml.md | 0 .../stripe/docs/google-pay/google-pay.ts.md | 0 .../stripe/docs/google-pay/strings.xml.md | 0 .../docs/src}/stripe/docs/initialize.md | 0 .../docs/src}/stripe/docs/ja/angular.md | 0 .../docs/src}/stripe/docs/ja/api.md | 0 .../docs/src}/stripe/docs/ja/apple-pay.md | 0 .../docs/src}/stripe/docs/ja/configuration.md | 0 .../docs/src}/stripe/docs/ja/google-pay.md | 0 .../docs/src}/stripe/docs/ja/initialize.md | 0 .../stripe/docs/ja/learn/event-listeners.md | 0 .../docs/src}/stripe/docs/ja/payment-flow.md | 0 .../docs/src}/stripe/docs/ja/payment-sheet.md | 0 .../docs/src}/stripe/docs/ja/react.md | 0 .../src}/stripe/docs/ja/server-integration.md | 0 .../docs/src}/stripe/docs/ja/vanilla-js.md | 0 .../src}/stripe/docs/learn/event-listeners.md | 0 .../docs/src}/stripe/docs/payment-flow.md | 0 .../docs/payment-flow/payment-flow.ts.md | 0 .../docs/src}/stripe/docs/payment-sheet.md | 0 .../docs/payment-sheet/payment-sheet.ts.md | 0 .../docs/src}/stripe/docs/react.md | 0 .../src}/stripe/docs/server-integration.md | 0 .../docs/src}/stripe/docs/vanilla-js.md | 0 {src => projects/docs/src}/styles.css | 0 .../docs/src}/workers-hono-kit/docs/api.md | 0 .../src}/workers-hono-kit/docs/data-layer.md | 0 .../workers-hono-kit/docs/getting-started.md | 0 .../src}/workers-hono-kit/docs/http-auth.md | 0 .../docs/src}/workers-hono-kit/docs/ja/api.md | 0 .../workers-hono-kit/docs/ja/data-layer.md | 0 .../docs/ja/getting-started.md | 0 .../workers-hono-kit/docs/ja/http-auth.md | 0 .../docs/ja/realtime-offline.md | 0 .../docs/ja/testing-operations.md | 0 .../workers-hono-kit/docs/realtime-offline.md | 0 .../docs/testing-operations.md | 0 .../docs/tsconfig.app.json | 2 +- .../docs/tsconfig.spec.json | 2 +- scripts/bilingual-update-blocker.test.ts | 4 +- scripts/build-output.test.ts | 50 +++------- scripts/generate-docs.ts | 17 ++-- scripts/generate-sponsors.ts | 16 +-- scripts/package-repository.test.ts | 2 +- scripts/package-repository.ts | 40 ++++++-- scripts/site-contract.test.ts | 80 +++++++++------ scripts/static-prepare.ts | 4 +- tsconfig.json | 5 +- wrangler.jsonc | 2 +- 343 files changed, 390 insertions(+), 350 deletions(-) rename {public => projects/docs/public}/404.html (100%) rename {public => projects/docs/public}/assets/brand/apple-touch-icon.png (100%) rename {public => projects/docs/public}/assets/brand/og-card.png (100%) rename {public => projects/docs/public}/assets/brand/og-card.svg (100%) rename {public => projects/docs/public}/assets/brand/rdlabo-logo.svg (100%) rename {public => projects/docs/public}/assets/icon/capacitor-logo.svg (100%) rename {public => projects/docs/public}/favicon.ico (100%) rename {public => projects/docs/public}/ja/404.html (100%) rename {public => projects/docs/public}/robots.txt (100%) rename {public => projects/docs/public}/sitemap.xml (100%) rename {src => projects/docs/src}/admob/docs/ja/app-open.md (100%) rename {src => projects/docs/src}/admob/docs/ja/banner.md (100%) rename {src => projects/docs/src}/admob/docs/ja/configuration.md (100%) rename {src => projects/docs/src}/admob/docs/ja/consent.md (100%) rename {src => projects/docs/src}/admob/docs/ja/events.md (100%) rename {src => projects/docs/src}/admob/docs/ja/interstitial.md (100%) rename {src => projects/docs/src}/admob/docs/ja/migration.md (100%) rename {src => projects/docs/src}/admob/docs/ja/readme.md (100%) rename {src => projects/docs/src}/admob/docs/ja/rewarded.md (100%) rename {src => projects/docs/src}/admob/docs/ja/testing.md (100%) rename {src => projects/docs/src}/app/app.config.server.ts (100%) rename {src => projects/docs/src}/app/app.config.ts (100%) rename {src => projects/docs/src}/app/app.css (100%) rename {src => projects/docs/src}/app/app.html (100%) rename {src => projects/docs/src}/app/app.routes.server.ts (100%) rename {src => projects/docs/src}/app/app.routes.spec.ts (100%) rename {src => projects/docs/src}/app/app.routes.ts (100%) rename {src => projects/docs/src}/app/app.spec.ts (100%) rename {src => projects/docs/src}/app/app.ts (100%) rename {src => projects/docs/src}/app/docs/code-panel.spec.ts (100%) rename {src => projects/docs/src}/app/docs/code-panel.ts (100%) rename {src => projects/docs/src}/app/docs/docs-data.ts (100%) rename {src => projects/docs/src}/app/docs/docs-page.ts (100%) rename {src => projects/docs/src}/app/docs/github-stars.service.spec.ts (100%) rename {src => projects/docs/src}/app/docs/github-stars.service.ts (100%) rename {src => projects/docs/src}/app/docs/landing-page.spec.ts (100%) rename {src => projects/docs/src}/app/docs/landing-page.ts (100%) rename {src => projects/docs/src}/app/docs/not-found.spec.ts (100%) rename {src => projects/docs/src}/app/docs/not-found.ts (100%) rename {src => projects/docs/src}/app/docs/plugin-index.spec.ts (100%) rename {src => projects/docs/src}/app/docs/plugin-index.ts (100%) rename {src => projects/docs/src}/app/docs/project-icon.ts (100%) rename {src => projects/docs/src}/app/docs/project.resolver.ts (100%) rename {src => projects/docs/src}/app/docs/safe-html.pipe.ts (100%) rename {src => projects/docs/src}/app/docs/scroll-spy.directive.ts (100%) rename {src => projects/docs/src}/app/docs/scroll-spy.spec.ts (100%) rename {src => projects/docs/src}/app/docs/scroll-spy.ts (100%) rename {src => projects/docs/src}/app/docs/seo.service.spec.ts (100%) rename {src => projects/docs/src}/app/docs/seo.service.ts (100%) rename {src => projects/docs/src}/app/docs/support-page.spec.ts (100%) rename {src => projects/docs/src}/app/docs/support-page.ts (100%) rename {src => projects/docs/src}/app/generated/project-catalog.generated.ts (100%) rename {src => projects/docs/src}/app/generated/project-loaders.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/admob.en.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/admob.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/capacitor-brotherprint.en.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/capacitor-brotherprint.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/capacitor-codescanner.en.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/capacitor-codescanner.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/capacitor-docgen.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/capacitor-docgen.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/capacitor-printer.en.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/capacitor-printer.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/capacitor-screenshot-event.en.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/capacitor-screenshot-event.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/eslint-plugin-rules.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/eslint-plugin-rules.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/facebook-login.en.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/facebook-login.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-collect-icons.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-collect-icons.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-kit.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-kit.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-photo-editor.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-photo-editor.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-scroll-header.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-angular-scroll-header.ja.generated.ts (98%) rename {src => projects/docs/src}/app/generated/projects/ionic-theme-ios26.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-theme-ios26.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-theme-md3.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ionic-theme-md3.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ngx-cdk-scroll-strategies.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/ngx-cdk-scroll-strategies.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/stripe-identity.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/stripe-identity.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/stripe-terminal.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/stripe-terminal.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/stripe.en.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/stripe.ja.generated.ts (99%) rename {src => projects/docs/src}/app/generated/projects/workers-hono-kit.en.generated.ts (100%) rename {src => projects/docs/src}/app/generated/projects/workers-hono-kit.ja.generated.ts (98%) rename {src => projects/docs/src}/app/generated/sponsors.generated.ts (100%) rename {src => projects/docs/src}/app/locale-path.ts (100%) rename {src => projects/docs/src}/app/site-config.ts (100%) rename {src => projects/docs/src}/capacitor-brotherprint/docs/ja/events.md (100%) rename {src => projects/docs/src}/capacitor-brotherprint/docs/ja/installation.md (100%) rename {src => projects/docs/src}/capacitor-brotherprint/docs/ja/print.md (100%) rename {src => projects/docs/src}/capacitor-brotherprint/docs/ja/readme.md (100%) rename {src => projects/docs/src}/capacitor-brotherprint/docs/ja/search.md (100%) rename {src => projects/docs/src}/capacitor-codescanner/docs/ja/code-scanner.md (100%) rename {src => projects/docs/src}/capacitor-codescanner/docs/ja/readme.md (100%) rename {src => projects/docs/src}/capacitor-docgen/docs/api.md (100%) rename {src => projects/docs/src}/capacitor-docgen/docs/getting-started.md (100%) rename {src => projects/docs/src}/capacitor-docgen/docs/ja/api.md (100%) rename {src => projects/docs/src}/capacitor-docgen/docs/ja/getting-started.md (100%) rename {src => projects/docs/src}/capacitor-docgen/docs/ja/upstream-differences.md (100%) rename {src => projects/docs/src}/capacitor-docgen/docs/upstream-differences.md (100%) rename {src => projects/docs/src}/capacitor-printer/docs/ja/pdf.md (100%) rename {src => projects/docs/src}/capacitor-printer/docs/ja/readme.md (100%) rename {src => projects/docs/src}/capacitor-printer/docs/ja/web.md (100%) rename {src => projects/docs/src}/capacitor-screenshot-event/docs/ja/readme.md (100%) rename {src => projects/docs/src}/capacitor-screenshot-event/docs/ja/screenshot-event.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/api.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/configuration.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/getting-started.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/api.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/configuration.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/getting-started.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/migration.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/component-property-use-readonly.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/deny-constructor-di.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/deny-element.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/deny-overlay-create.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/deny-soft-private-modifier.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/implements-ionic-lifecycle.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/ionic-attr-type-check.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/no-component-method-except-lifecycle.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/no-component-writable-signal.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/no-reactive-forms.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/no-template-driven-forms.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/prefer-disable-handler.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/prefer-ionic-standalone.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/prefer-modal-launcher.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/require-ion-item-group.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/require-viewmodel.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/restrict-try-block.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal-template.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/component-property-use-readonly.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/deny-constructor-di.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/deny-element.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/deny-import-from-ionic-module.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/deny-overlay-create.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/deny-soft-private-modifier.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/implements-ionic-lifecycle.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/ionic-attr-type-check.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/no-component-method-except-lifecycle.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/no-component-writable-signal.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/no-reactive-forms.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/no-template-driven-forms.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/prefer-disable-handler.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/prefer-modal-launcher.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/require-viewmodel.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/restrict-try-block.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/signal-use-as-signal-template.md (100%) rename {src => projects/docs/src}/eslint-plugin-rules/docs/rules/signal-use-as-signal.md (100%) rename {src => projects/docs/src}/facebook-login/docs/ja/app-events.md (100%) rename {src => projects/docs/src}/facebook-login/docs/ja/authentication.md (100%) rename {src => projects/docs/src}/facebook-login/docs/ja/configuration.md (100%) rename {src => projects/docs/src}/facebook-login/docs/ja/readme.md (100%) rename {src => projects/docs/src}/index.html (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/api.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/faq.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/initialize.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/ja/api.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/ja/faq.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/ja/initialize.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/ja/migration.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/ja/options.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/ja/readme.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/ja/usage.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/options.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/readme.md (100%) rename {src => projects/docs/src}/ionic-angular-collect-icons/docs/usage.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/api.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/auth-http.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/getting-started.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/ja/api.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/ja/auth-http.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/ja/getting-started.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/ja/offline-realtime.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/ja/optional-features.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/ja/storage-overlays.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/offline-realtime.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/optional-features.md (100%) rename {src => projects/docs/src}/ionic-angular-kit/docs/storage-overlays.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/api.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/editor.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/ja/api.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/ja/editor.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/ja/photo-file.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/ja/readme.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/ja/theme.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/ja/viewer.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/photo-file.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/readme.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/theme.md (100%) rename {src => projects/docs/src}/ionic-angular-photo-editor/docs/viewer.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/api.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/ion-content.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/ja/api.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/ja/ion-content.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/ja/readme.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/ja/safe-area.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/ja/virtual-scroll.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/readme.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/safe-area.md (100%) rename {src => projects/docs/src}/ionic-angular-scroll-header/docs/virtual-scroll.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/api.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/experimental-animation.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/features.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ios-18.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/api.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/experimental-animation.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/features.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/ios-18.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/migration.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/readme.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/special-markup.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/ja/using-ion-item-group.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/migration.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/readme.md (100%) rename {src => projects/docs/src}/ionic-theme-ios26/docs/using-ion-item-group.md (100%) rename {src => projects/docs/src}/ionic-theme-md3/docs/api.md (100%) rename {src => projects/docs/src}/ionic-theme-md3/docs/ja/api.md (100%) rename {src => projects/docs/src}/ionic-theme-md3/docs/ja/migration.md (100%) rename {src => projects/docs/src}/ionic-theme-md3/docs/ja/readme.md (100%) rename {src => projects/docs/src}/ionic-theme-md3/docs/ja/special-markup.md (100%) rename {src => projects/docs/src}/ionic-theme-md3/docs/ja/using-ion-item-group.md (100%) rename {src => projects/docs/src}/ionic-theme-md3/docs/readme.md (100%) rename {src => projects/docs/src}/locale/messages.en.xlf (66%) rename {src => projects/docs/src}/locale/messages.ja.xlf (100%) rename {src => projects/docs/src}/main.server.ts (100%) rename {src => projects/docs/src}/main.ts (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/advanced.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/api.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/faq.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/ja/advanced.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/ja/api.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/ja/faq.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/ja/readme.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/ja/reverse.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/ja/simple.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/readme.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/reverse.md (100%) rename {src => projects/docs/src}/ngx-cdk-scroll-strategies/docs/simple.md (100%) rename {src => projects/docs/src}/server.ts (100%) rename {src => projects/docs/src}/stripe-identity/config/docs.json (100%) rename {src => projects/docs/src}/stripe-identity/config/packages.json (100%) rename {src => projects/docs/src}/stripe-identity/docs/api.md (100%) rename {src => projects/docs/src}/stripe-identity/docs/configuration.md (100%) rename {src => projects/docs/src}/stripe-identity/docs/identity-verification-sheet.md (100%) rename {src => projects/docs/src}/stripe-identity/docs/identity-verification-sheet/example.ts.md (100%) rename {src => projects/docs/src}/stripe-identity/docs/ja/api.md (100%) rename {src => projects/docs/src}/stripe-identity/docs/ja/configuration.md (100%) rename {src => projects/docs/src}/stripe-identity/docs/ja/identity-verification-sheet.md (100%) rename {src => projects/docs/src}/stripe-terminal/config/docs.json (100%) rename {src => projects/docs/src}/stripe-terminal/config/packages.json (100%) rename {src => projects/docs/src}/stripe-terminal/docs/api.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/collect-a-payment.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/collect-a-payment/collect-payment.ts.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/collect-a-payment/connection-token.ts.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/configuration.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/ja/api.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/ja/collect-a-payment.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/ja/configuration.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/ja/reader-lifecycle.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/ja/tap-to-pay.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/reader-lifecycle.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/reader-lifecycle/reader-lifecycle.ts.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/tap-to-pay.md (100%) rename {src => projects/docs/src}/stripe-terminal/docs/tap-to-pay/tap-to-pay.ts.md (100%) rename {src => projects/docs/src}/stripe/assets/capacitor-image.png (100%) rename {src => projects/docs/src}/stripe/assets/doctr.svg (100%) rename {src => projects/docs/src}/stripe/assets/sunset.png (100%) rename {src => projects/docs/src}/stripe/assets/vegasbuilt.svg (100%) rename {src => projects/docs/src}/stripe/config/docs.json (100%) rename {src => projects/docs/src}/stripe/config/packages.json (100%) rename {src => projects/docs/src}/stripe/docs/angular.md (100%) rename {src => projects/docs/src}/stripe/docs/api.md (100%) rename {src => projects/docs/src}/stripe/docs/apple-pay.md (100%) rename {src => projects/docs/src}/stripe/docs/apple-pay/apple-pay.ts.md (100%) rename {src => projects/docs/src}/stripe/docs/configuration.md (100%) rename {src => projects/docs/src}/stripe/docs/google-pay.md (100%) rename {src => projects/docs/src}/stripe/docs/google-pay/android-manifest.xml.md (100%) rename {src => projects/docs/src}/stripe/docs/google-pay/google-pay.ts.md (100%) rename {src => projects/docs/src}/stripe/docs/google-pay/strings.xml.md (100%) rename {src => projects/docs/src}/stripe/docs/initialize.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/angular.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/api.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/apple-pay.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/configuration.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/google-pay.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/initialize.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/learn/event-listeners.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/payment-flow.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/payment-sheet.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/react.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/server-integration.md (100%) rename {src => projects/docs/src}/stripe/docs/ja/vanilla-js.md (100%) rename {src => projects/docs/src}/stripe/docs/learn/event-listeners.md (100%) rename {src => projects/docs/src}/stripe/docs/payment-flow.md (100%) rename {src => projects/docs/src}/stripe/docs/payment-flow/payment-flow.ts.md (100%) rename {src => projects/docs/src}/stripe/docs/payment-sheet.md (100%) rename {src => projects/docs/src}/stripe/docs/payment-sheet/payment-sheet.ts.md (100%) rename {src => projects/docs/src}/stripe/docs/react.md (100%) rename {src => projects/docs/src}/stripe/docs/server-integration.md (100%) rename {src => projects/docs/src}/stripe/docs/vanilla-js.md (100%) rename {src => projects/docs/src}/styles.css (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/api.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/data-layer.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/getting-started.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/http-auth.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/ja/api.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/ja/data-layer.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/ja/getting-started.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/ja/http-auth.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/ja/realtime-offline.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/ja/testing-operations.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/realtime-offline.md (100%) rename {src => projects/docs/src}/workers-hono-kit/docs/testing-operations.md (100%) rename tsconfig.app.json => projects/docs/tsconfig.app.json (79%) rename tsconfig.spec.json => projects/docs/tsconfig.spec.json (79%) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 81216eb..c4c3298 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,6 +28,6 @@ jobs: - run: npm run fmt:check - run: npm run lint - run: npm test - - run: git diff --exit-code -- src/app/generated public/sitemap.xml + - run: git diff --exit-code -- projects/docs/src/app/generated projects/docs/public/sitemap.xml - run: npm run build - - run: git diff --exit-code -- src/app/generated public/sitemap.xml + - run: git diff --exit-code -- projects/docs/src/app/generated projects/docs/public/sitemap.xml diff --git a/.prettierignore b/.prettierignore index bbf04e3..b06d215 100644 --- a/.prettierignore +++ b/.prettierignore @@ -6,14 +6,14 @@ node_modules coverage package-lock.json _stencil -public -src/stripe/docs -src/stripe/assets -src/stripe/config -src/stripe-identity/docs -src/stripe-identity/config -src/app/generated -src/**/docs +projects/docs/public +projects/docs/src/stripe/docs +projects/docs/src/stripe/assets +projects/docs/src/stripe/config +projects/docs/src/stripe-identity/docs +projects/docs/src/stripe-identity/config +projects/docs/src/app/generated +projects/docs/src/**/docs *.png *.ico *.svg diff --git a/.prettierrc.json b/.prettierrc.json index c89ab4f..e5547c7 100644 --- a/.prettierrc.json +++ b/.prettierrc.json @@ -8,7 +8,7 @@ "trailingComma": "all", "useTabs": false, "plugins": ["prettier-plugin-tailwindcss"], - "tailwindStylesheet": "./src/styles.css", + "tailwindStylesheet": "./projects/docs/src/styles.css", "overrides": [ { "files": "*.html", diff --git a/AGENTS.md b/AGENTS.md index f5bc5a1..9fd9684 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,17 +1,17 @@ # rdlabo-docs -`rdlabo-docs` is the bilingual documentation portal for rdlabo OSS. It generates static Angular pages from source packages (pinned in `package-lock.json`) and Markdown under `src/{project}/docs/`. +`rdlabo-docs` is the bilingual documentation portal for rdlabo OSS. It generates static Angular pages from source packages (pinned in `package-lock.json`) and Markdown under `projects/docs/src/{project}/docs/`. ## Quick reference -| Task | Where | -| -------------------------------------------------- | --------------------------------------------------------------------------- | -| Add/remove a project, change page list or metadata | `scripts/project-manifest.ts` | -| Write/edit Japanese documentation | `src/{project}/docs/ja/` | -| Write/edit English for portal-hosted projects | `src/{project}/docs/` (read via GitHub raw, not local checkout) | -| Write/edit English for package-hosted projects | The OSS package repository | -| Bump a package version | `package.json` pin → `npm install` → `npm run docs:generate` | -| Regenerate all pages | `npm run docs:generate` (output: `src/app/generated/` — never edit by hand) | +| Task | Where | +| -------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| Add/remove a project, change page list or metadata | `scripts/project-manifest.ts` | +| Write/edit Japanese documentation | `projects/docs/src/{project}/docs/ja/` | +| Write/edit English for portal-hosted projects | `projects/docs/src/{project}/docs/` (read via GitHub raw, not local checkout) | +| Write/edit English for package-hosted projects | The OSS package repository | +| Bump a package version | `package.json` pin → `npm install` → `npm run docs:generate` | +| Regenerate all pages | `npm run docs:generate` (output: `projects/docs/src/app/generated/` — never edit by hand) | ## Page roles @@ -25,13 +25,13 @@ ## Content ownership -| Content | Source of truth | Edit in | -| --------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| English guides and landing pages | GitHub raw (package repo first, then portal repo) | Package repo when docs are published there; otherwise `src/{project}/docs/` in this repo on GitHub | -| Japanese guides and landing pages | `src/{project}/docs/ja/*.md` only | This portal | -| `!::Identifier::` API signatures | Installed npm package `dist/docs.json` | Package repo; release and bump the pin here | -| Docgen API page (`` + ``) | Package or portal `readme.md` on GitHub | Same repository as the English landing page | -| Code example files (`code:` refs) | `src/{project}/docs/` (not translated) | This portal | +| Content | Source of truth | Edit in | +| --------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| English guides and landing pages | GitHub raw (package repo first, then portal repo) | Package repo when docs are published there; otherwise `projects/docs/src/{project}/docs/` in this repo on GitHub | +| Japanese guides and landing pages | `projects/docs/src/{project}/docs/ja/*.md` only | This portal | +| `!::Identifier::` API signatures | Installed npm package `dist/docs.json` | Package repo; release and bump the pin here | +| Docgen API page (`` + ``) | Package or portal `readme.md` on GitHub | Same repository as the English landing page | +| Code example files (`code:` refs) | `projects/docs/src/{project}/docs/` (not translated) | This portal | ## Generation pipeline @@ -40,9 +40,9 @@ `docs:generate` **always** loads English from GitHub raw — never from the local filesystem. Resolution order: 1. Package repository: `docs/{file}`, `{sourceDirectory}/docs/{file}`, then `README.md` for landings. -2. Portal repository (`rdlabo-dev/website`): `src/{sourceDirectory}/docs/{file}`. +2. Portal repository (`rdlabo-dev/website`): `projects/docs/src/{sourceDirectory}/docs/{file}`. -For `@capacitor-community/admob` and rdlabo Capacitor plugins, English lives in the **package repository only** — do not copy those English files into `src/{project}/docs/`. +For `@capacitor-community/admob` and rdlabo Capacitor plugins, English lives in the **package repository only** — do not copy those English files into `projects/docs/src/{project}/docs/`. Optional `englishDocsRef` overrides the Git ref for English guides fetched from the package repository (default: `main`). API signatures always follow the installed npm version, not the Git ref. @@ -83,8 +83,8 @@ Use a kind tag so `formatApiEntries` wraps each entry in an `api-entry` card. Su ### File structure -- Every page in `project-manifest.ts` must have an English source on GitHub and a Japanese counterpart at `src/{project}/docs/ja/{file}`. -- Package-hosted English (AdMob, rdlabo Capacitor plugins) must **not** be duplicated under `src/{project}/docs/`. +- Every page in `project-manifest.ts` must have an English source on GitHub and a Japanese counterpart at `projects/docs/src/{project}/docs/ja/{file}`. +- Package-hosted English (AdMob, rdlabo Capacitor plugins) must **not** be duplicated under `projects/docs/src/{project}/docs/`. - Code example files (`code:` refs) are not translated. ### Translation rules diff --git a/README.md b/README.md index 856180f..8c6e30f 100644 --- a/README.md +++ b/README.md @@ -12,25 +12,25 @@ Production is `docs.rdlabo.dev` on Cloudflare Workers Static Assets. The reposit | --- | --- | | Ionic Framework Japanese Documentation | `ionic-jp/ionic-docs` | | Capacitor Japanese Documentation | `ionic-jp/capacitor-docs` | -| Capacitor Community Stripe | `src/stripe/docs` | -| Capacitor Community Stripe Identity | `src/stripe-identity/docs` | -| Capacitor Community Stripe Terminal | `src/stripe-terminal/docs` | -| Capacitor Community AdMob | `src/admob/docs` | -| Capacitor Community Facebook Login | `src/facebook-login/docs` | -| rdlabo Capacitor Code Scanner | `src/capacitor-codescanner/docs` | -| rdlabo Capacitor Screenshot Event | `src/capacitor-screenshot-event/docs` | -| rdlabo Capacitor Printer | `src/capacitor-printer/docs` | -| rdlabo Capacitor Brother Print | `src/capacitor-brotherprint/docs` | -| rdlabo Ionic Angular Kit | `src/ionic-angular-kit/docs` | -| rdlabo Ionic Angular Photo Editor | `src/ionic-angular-photo-editor/docs` | -| rdlabo Ionic Angular Scroll Header | `src/ionic-angular-scroll-header/docs` | -| rdlabo Angular CDK Scroll Strategies | `src/ngx-cdk-scroll-strategies/docs` | -| rdlabo Ionic Theme iOS26 | `src/ionic-theme-ios26/docs` | -| rdlabo Ionic Theme Material Design 3 | `src/ionic-theme-md3/docs` | -| rdlabo Ionic Angular Collect Icons | `src/ionic-angular-collect-icons/docs` | -| rdlabo Workers Hono Kit | `src/workers-hono-kit/docs` | -| rdlabo ESLint Plugin Rules | `src/eslint-plugin-rules/docs` | -| rdlabo Capacitor Docgen | `src/capacitor-docgen/docs` | +| Capacitor Community Stripe | `projects/docs/src/stripe/docs` | +| Capacitor Community Stripe Identity | `projects/docs/src/stripe-identity/docs` | +| Capacitor Community Stripe Terminal | `projects/docs/src/stripe-terminal/docs` | +| Capacitor Community AdMob | `projects/docs/src/admob/docs` | +| Capacitor Community Facebook Login | `projects/docs/src/facebook-login/docs` | +| rdlabo Capacitor Code Scanner | `projects/docs/src/capacitor-codescanner/docs` | +| rdlabo Capacitor Screenshot Event | `projects/docs/src/capacitor-screenshot-event/docs` | +| rdlabo Capacitor Printer | `projects/docs/src/capacitor-printer/docs` | +| rdlabo Capacitor Brother Print | `projects/docs/src/capacitor-brotherprint/docs` | +| rdlabo Ionic Angular Kit | `projects/docs/src/ionic-angular-kit/docs` | +| rdlabo Ionic Angular Photo Editor | `projects/docs/src/ionic-angular-photo-editor/docs` | +| rdlabo Ionic Angular Scroll Header | `projects/docs/src/ionic-angular-scroll-header/docs` | +| rdlabo Angular CDK Scroll Strategies | `projects/docs/src/ngx-cdk-scroll-strategies/docs` | +| rdlabo Ionic Theme iOS26 | `projects/docs/src/ionic-theme-ios26/docs` | +| rdlabo Ionic Theme Material Design 3 | `projects/docs/src/ionic-theme-md3/docs` | +| rdlabo Ionic Angular Collect Icons | `projects/docs/src/ionic-angular-collect-icons/docs` | +| rdlabo Workers Hono Kit | `projects/docs/src/workers-hono-kit/docs` | +| rdlabo ESLint Plugin Rules | `projects/docs/src/eslint-plugin-rules/docs` | +| rdlabo Capacitor Docgen | `projects/docs/src/capacitor-docgen/docs` | Project metadata, navigation, localized landing copy, and API input are declared in `scripts/project-manifest.ts`. The generator creates a small catalog plus one lazy module per project and locale. @@ -84,7 +84,7 @@ Every project exposes a dedicated API page. Hand-authored API Markdown uses sema such as `` #### `component` PhotoEditorPage `` or `` #### `function` generate ``; the generator normalizes those entries and Capacitor docgen output into the same API-card presentation. -Generated project modules live under `src/app/generated/projects` and must not be edited by hand. +Generated project modules live under `projects/docs/src/app/generated/projects` and must not be edited by hand. API input is restricted to packages declared in `scripts/project-manifest.ts` and installed at exact versions in `package-lock.json`. Generated HTML is reviewed as part of the repository diff; adding a diff --git a/angular.json b/angular.json index 59de6eb..8c19800 100644 --- a/angular.json +++ b/angular.json @@ -8,11 +8,11 @@ }, "newProjectRoot": "projects", "projects": { - "capacitor-plugins-docs": { + "docs": { "projectType": "application", "schematics": {}, - "root": "", - "sourceRoot": "src", + "root": "projects/docs", + "sourceRoot": "projects/docs/src", "prefix": "app", "i18n": { "sourceLocale": { @@ -21,7 +21,7 @@ }, "locales": { "ja": { - "translation": "src/locale/messages.ja.xlf", + "translation": "projects/docs/src/locale/messages.ja.xlf", "subPath": "ja" } } @@ -30,27 +30,27 @@ "build": { "builder": "@angular/build:application", "options": { - "browser": "src/main.ts", - "tsConfig": "tsconfig.app.json", + "browser": "projects/docs/src/main.ts", + "tsConfig": "projects/docs/tsconfig.app.json", "assets": [ { "glob": "**/*", - "input": "public" + "input": "projects/docs/public" }, { "glob": "**/*", - "input": "src/stripe/assets", + "input": "projects/docs/src/stripe/assets", "output": "assets/stripe" } ], - "styles": ["src/styles.css"], - "server": "src/main.server.ts", + "styles": ["projects/docs/src/styles.css"], + "server": "projects/docs/src/main.server.ts", "outputMode": "static", "security": { "allowedHosts": [] }, "ssr": { - "entry": "src/server.ts" + "entry": "projects/docs/src/server.ts" }, "polyfills": ["@angular/localize/init"], "localize": true, @@ -93,13 +93,13 @@ "builder": "@angular/build:dev-server", "configurations": { "production": { - "buildTarget": "capacitor-plugins-docs:build:production" + "buildTarget": "docs:build:production" }, "development": { - "buildTarget": "capacitor-plugins-docs:build:development" + "buildTarget": "docs:build:development" }, "ja": { - "buildTarget": "capacitor-plugins-docs:build:development,ja" + "buildTarget": "docs:build:development,ja" } }, "defaultConfiguration": "development" @@ -107,14 +107,14 @@ "extract-i18n": { "builder": "@angular/build:extract-i18n", "options": { - "buildTarget": "capacitor-plugins-docs:build:development" + "buildTarget": "docs:build:development" } }, "test": { "builder": "@angular/build:unit-test", "options": { - "tsConfig": "tsconfig.spec.json", - "buildTarget": "capacitor-plugins-docs:build", + "tsConfig": "projects/docs/tsconfig.spec.json", + "buildTarget": "docs:build", "runner": "vitest" }, "configurations": { @@ -126,7 +126,11 @@ "lint": { "builder": "@angular-eslint/builder:lint", "options": { - "lintFilePatterns": ["src/**/*.ts", "src/**/*.html", "scripts/**/*.ts"] + "lintFilePatterns": [ + "projects/docs/src/**/*.ts", + "projects/docs/src/**/*.html", + "scripts/**/*.ts" + ] } } } diff --git a/eslint.config.js b/eslint.config.js index b5b4992..dd085a3 100644 --- a/eslint.config.js +++ b/eslint.config.js @@ -11,10 +11,10 @@ module.exports = defineConfig([ 'dist/**', 'coverage/**', '.angular/**', - 'src/app/generated/**', - 'src/stripe/**', - 'src/stripe-identity/**', - 'src/stripe-terminal/**', + 'projects/docs/src/app/generated/**', + 'projects/docs/src/stripe/**', + 'projects/docs/src/stripe-identity/**', + 'projects/docs/src/stripe-terminal/**', ], }, { @@ -22,7 +22,7 @@ module.exports = defineConfig([ }, ...rdlabo.configs.recommended, { - files: ['src/**/*.ts'], + files: ['projects/docs/src/**/*.ts'], extends: [ eslint.configs.recommended, tseslint.configs.recommended, diff --git a/package.json b/package.json index f2bc44c..868f395 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "start:ja": "ng serve --configuration ja", "prebuild": "npm run docs:generate", "static:prepare": "tsx scripts/static-prepare.ts", - "build": "ng build && npm run static:prepare && pagefind --site dist/capacitor-plugins-docs/browser --output-subdir pagefind && tsx --test scripts/build-output.test.ts", + "build": "ng build && npm run static:prepare && pagefind --site dist/docs/browser --output-subdir pagefind && tsx --test scripts/build-output.test.ts", "watch": "ng build --watch --configuration development", "pretest": "npm run docs:generate", "test": "tsx --test scripts/docgen-readme.test.ts scripts/html-policy.test.ts scripts/markdown-headings.test.ts scripts/package-markdown.test.ts scripts/package-repository.test.ts scripts/github-sponsors.test.ts scripts/bilingual-update-blocker.test.ts scripts/site-contract.test.ts && ng test --watch=false", @@ -23,7 +23,7 @@ "fmt:check": "prettier --check .", "deploy": "npm run build && wrangler deploy", "deploy:dry-run": "npm run build && wrangler deploy --dry-run", - "serve:ssr:capacitor-plugins-docs": "node dist/capacitor-plugins-docs/server/server.mjs", + "serve:ssr:docs": "node dist/docs/server/server.mjs", "lint": "ng lint" }, "dependencies": { diff --git a/public/404.html b/projects/docs/public/404.html similarity index 100% rename from public/404.html rename to projects/docs/public/404.html diff --git a/public/assets/brand/apple-touch-icon.png b/projects/docs/public/assets/brand/apple-touch-icon.png similarity index 100% rename from public/assets/brand/apple-touch-icon.png rename to projects/docs/public/assets/brand/apple-touch-icon.png diff --git a/public/assets/brand/og-card.png b/projects/docs/public/assets/brand/og-card.png similarity index 100% rename from public/assets/brand/og-card.png rename to projects/docs/public/assets/brand/og-card.png diff --git a/public/assets/brand/og-card.svg b/projects/docs/public/assets/brand/og-card.svg similarity index 100% rename from public/assets/brand/og-card.svg rename to projects/docs/public/assets/brand/og-card.svg diff --git a/public/assets/brand/rdlabo-logo.svg b/projects/docs/public/assets/brand/rdlabo-logo.svg similarity index 100% rename from public/assets/brand/rdlabo-logo.svg rename to projects/docs/public/assets/brand/rdlabo-logo.svg diff --git a/public/assets/icon/capacitor-logo.svg b/projects/docs/public/assets/icon/capacitor-logo.svg similarity index 100% rename from public/assets/icon/capacitor-logo.svg rename to projects/docs/public/assets/icon/capacitor-logo.svg diff --git a/public/favicon.ico b/projects/docs/public/favicon.ico similarity index 100% rename from public/favicon.ico rename to projects/docs/public/favicon.ico diff --git a/public/ja/404.html b/projects/docs/public/ja/404.html similarity index 100% rename from public/ja/404.html rename to projects/docs/public/ja/404.html diff --git a/public/robots.txt b/projects/docs/public/robots.txt similarity index 100% rename from public/robots.txt rename to projects/docs/public/robots.txt diff --git a/public/sitemap.xml b/projects/docs/public/sitemap.xml similarity index 100% rename from public/sitemap.xml rename to projects/docs/public/sitemap.xml diff --git a/src/admob/docs/ja/app-open.md b/projects/docs/src/admob/docs/ja/app-open.md similarity index 100% rename from src/admob/docs/ja/app-open.md rename to projects/docs/src/admob/docs/ja/app-open.md diff --git a/src/admob/docs/ja/banner.md b/projects/docs/src/admob/docs/ja/banner.md similarity index 100% rename from src/admob/docs/ja/banner.md rename to projects/docs/src/admob/docs/ja/banner.md diff --git a/src/admob/docs/ja/configuration.md b/projects/docs/src/admob/docs/ja/configuration.md similarity index 100% rename from src/admob/docs/ja/configuration.md rename to projects/docs/src/admob/docs/ja/configuration.md diff --git a/src/admob/docs/ja/consent.md b/projects/docs/src/admob/docs/ja/consent.md similarity index 100% rename from src/admob/docs/ja/consent.md rename to projects/docs/src/admob/docs/ja/consent.md diff --git a/src/admob/docs/ja/events.md b/projects/docs/src/admob/docs/ja/events.md similarity index 100% rename from src/admob/docs/ja/events.md rename to projects/docs/src/admob/docs/ja/events.md diff --git a/src/admob/docs/ja/interstitial.md b/projects/docs/src/admob/docs/ja/interstitial.md similarity index 100% rename from src/admob/docs/ja/interstitial.md rename to projects/docs/src/admob/docs/ja/interstitial.md diff --git a/src/admob/docs/ja/migration.md b/projects/docs/src/admob/docs/ja/migration.md similarity index 100% rename from src/admob/docs/ja/migration.md rename to projects/docs/src/admob/docs/ja/migration.md diff --git a/src/admob/docs/ja/readme.md b/projects/docs/src/admob/docs/ja/readme.md similarity index 100% rename from src/admob/docs/ja/readme.md rename to projects/docs/src/admob/docs/ja/readme.md diff --git a/src/admob/docs/ja/rewarded.md b/projects/docs/src/admob/docs/ja/rewarded.md similarity index 100% rename from src/admob/docs/ja/rewarded.md rename to projects/docs/src/admob/docs/ja/rewarded.md diff --git a/src/admob/docs/ja/testing.md b/projects/docs/src/admob/docs/ja/testing.md similarity index 100% rename from src/admob/docs/ja/testing.md rename to projects/docs/src/admob/docs/ja/testing.md diff --git a/src/app/app.config.server.ts b/projects/docs/src/app/app.config.server.ts similarity index 100% rename from src/app/app.config.server.ts rename to projects/docs/src/app/app.config.server.ts diff --git a/src/app/app.config.ts b/projects/docs/src/app/app.config.ts similarity index 100% rename from src/app/app.config.ts rename to projects/docs/src/app/app.config.ts diff --git a/src/app/app.css b/projects/docs/src/app/app.css similarity index 100% rename from src/app/app.css rename to projects/docs/src/app/app.css diff --git a/src/app/app.html b/projects/docs/src/app/app.html similarity index 100% rename from src/app/app.html rename to projects/docs/src/app/app.html diff --git a/src/app/app.routes.server.ts b/projects/docs/src/app/app.routes.server.ts similarity index 100% rename from src/app/app.routes.server.ts rename to projects/docs/src/app/app.routes.server.ts diff --git a/src/app/app.routes.spec.ts b/projects/docs/src/app/app.routes.spec.ts similarity index 100% rename from src/app/app.routes.spec.ts rename to projects/docs/src/app/app.routes.spec.ts diff --git a/src/app/app.routes.ts b/projects/docs/src/app/app.routes.ts similarity index 100% rename from src/app/app.routes.ts rename to projects/docs/src/app/app.routes.ts diff --git a/src/app/app.spec.ts b/projects/docs/src/app/app.spec.ts similarity index 100% rename from src/app/app.spec.ts rename to projects/docs/src/app/app.spec.ts diff --git a/src/app/app.ts b/projects/docs/src/app/app.ts similarity index 100% rename from src/app/app.ts rename to projects/docs/src/app/app.ts diff --git a/src/app/docs/code-panel.spec.ts b/projects/docs/src/app/docs/code-panel.spec.ts similarity index 100% rename from src/app/docs/code-panel.spec.ts rename to projects/docs/src/app/docs/code-panel.spec.ts diff --git a/src/app/docs/code-panel.ts b/projects/docs/src/app/docs/code-panel.ts similarity index 100% rename from src/app/docs/code-panel.ts rename to projects/docs/src/app/docs/code-panel.ts diff --git a/src/app/docs/docs-data.ts b/projects/docs/src/app/docs/docs-data.ts similarity index 100% rename from src/app/docs/docs-data.ts rename to projects/docs/src/app/docs/docs-data.ts diff --git a/src/app/docs/docs-page.ts b/projects/docs/src/app/docs/docs-page.ts similarity index 100% rename from src/app/docs/docs-page.ts rename to projects/docs/src/app/docs/docs-page.ts diff --git a/src/app/docs/github-stars.service.spec.ts b/projects/docs/src/app/docs/github-stars.service.spec.ts similarity index 100% rename from src/app/docs/github-stars.service.spec.ts rename to projects/docs/src/app/docs/github-stars.service.spec.ts diff --git a/src/app/docs/github-stars.service.ts b/projects/docs/src/app/docs/github-stars.service.ts similarity index 100% rename from src/app/docs/github-stars.service.ts rename to projects/docs/src/app/docs/github-stars.service.ts diff --git a/src/app/docs/landing-page.spec.ts b/projects/docs/src/app/docs/landing-page.spec.ts similarity index 100% rename from src/app/docs/landing-page.spec.ts rename to projects/docs/src/app/docs/landing-page.spec.ts diff --git a/src/app/docs/landing-page.ts b/projects/docs/src/app/docs/landing-page.ts similarity index 100% rename from src/app/docs/landing-page.ts rename to projects/docs/src/app/docs/landing-page.ts diff --git a/src/app/docs/not-found.spec.ts b/projects/docs/src/app/docs/not-found.spec.ts similarity index 100% rename from src/app/docs/not-found.spec.ts rename to projects/docs/src/app/docs/not-found.spec.ts diff --git a/src/app/docs/not-found.ts b/projects/docs/src/app/docs/not-found.ts similarity index 100% rename from src/app/docs/not-found.ts rename to projects/docs/src/app/docs/not-found.ts diff --git a/src/app/docs/plugin-index.spec.ts b/projects/docs/src/app/docs/plugin-index.spec.ts similarity index 100% rename from src/app/docs/plugin-index.spec.ts rename to projects/docs/src/app/docs/plugin-index.spec.ts diff --git a/src/app/docs/plugin-index.ts b/projects/docs/src/app/docs/plugin-index.ts similarity index 100% rename from src/app/docs/plugin-index.ts rename to projects/docs/src/app/docs/plugin-index.ts diff --git a/src/app/docs/project-icon.ts b/projects/docs/src/app/docs/project-icon.ts similarity index 100% rename from src/app/docs/project-icon.ts rename to projects/docs/src/app/docs/project-icon.ts diff --git a/src/app/docs/project.resolver.ts b/projects/docs/src/app/docs/project.resolver.ts similarity index 100% rename from src/app/docs/project.resolver.ts rename to projects/docs/src/app/docs/project.resolver.ts diff --git a/src/app/docs/safe-html.pipe.ts b/projects/docs/src/app/docs/safe-html.pipe.ts similarity index 100% rename from src/app/docs/safe-html.pipe.ts rename to projects/docs/src/app/docs/safe-html.pipe.ts diff --git a/src/app/docs/scroll-spy.directive.ts b/projects/docs/src/app/docs/scroll-spy.directive.ts similarity index 100% rename from src/app/docs/scroll-spy.directive.ts rename to projects/docs/src/app/docs/scroll-spy.directive.ts diff --git a/src/app/docs/scroll-spy.spec.ts b/projects/docs/src/app/docs/scroll-spy.spec.ts similarity index 100% rename from src/app/docs/scroll-spy.spec.ts rename to projects/docs/src/app/docs/scroll-spy.spec.ts diff --git a/src/app/docs/scroll-spy.ts b/projects/docs/src/app/docs/scroll-spy.ts similarity index 100% rename from src/app/docs/scroll-spy.ts rename to projects/docs/src/app/docs/scroll-spy.ts diff --git a/src/app/docs/seo.service.spec.ts b/projects/docs/src/app/docs/seo.service.spec.ts similarity index 100% rename from src/app/docs/seo.service.spec.ts rename to projects/docs/src/app/docs/seo.service.spec.ts diff --git a/src/app/docs/seo.service.ts b/projects/docs/src/app/docs/seo.service.ts similarity index 100% rename from src/app/docs/seo.service.ts rename to projects/docs/src/app/docs/seo.service.ts diff --git a/src/app/docs/support-page.spec.ts b/projects/docs/src/app/docs/support-page.spec.ts similarity index 100% rename from src/app/docs/support-page.spec.ts rename to projects/docs/src/app/docs/support-page.spec.ts diff --git a/src/app/docs/support-page.ts b/projects/docs/src/app/docs/support-page.ts similarity index 100% rename from src/app/docs/support-page.ts rename to projects/docs/src/app/docs/support-page.ts diff --git a/src/app/generated/project-catalog.generated.ts b/projects/docs/src/app/generated/project-catalog.generated.ts similarity index 100% rename from src/app/generated/project-catalog.generated.ts rename to projects/docs/src/app/generated/project-catalog.generated.ts diff --git a/src/app/generated/project-loaders.generated.ts b/projects/docs/src/app/generated/project-loaders.generated.ts similarity index 100% rename from src/app/generated/project-loaders.generated.ts rename to projects/docs/src/app/generated/project-loaders.generated.ts diff --git a/src/app/generated/projects/admob.en.generated.ts b/projects/docs/src/app/generated/projects/admob.en.generated.ts similarity index 100% rename from src/app/generated/projects/admob.en.generated.ts rename to projects/docs/src/app/generated/projects/admob.en.generated.ts diff --git a/src/app/generated/projects/admob.ja.generated.ts b/projects/docs/src/app/generated/projects/admob.ja.generated.ts similarity index 99% rename from src/app/generated/projects/admob.ja.generated.ts rename to projects/docs/src/app/generated/projects/admob.ja.generated.ts index f3177d0..5d525e7 100644 --- a/src/app/generated/projects/admob.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/admob.ja.generated.ts @@ -100,7 +100,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/readme.md" }, { "title": "初期化", @@ -124,7 +124,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/configuration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/configuration.md" }, { "title": "同意管理", @@ -208,7 +208,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/consent.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/consent.md" }, { "title": "バナー広告", @@ -267,7 +267,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/banner.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/banner.md" }, { "title": "インタースティシャル広告", @@ -301,7 +301,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/interstitial.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/interstitial.md" }, { "title": "リワード広告", @@ -375,7 +375,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/rewarded.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/rewarded.md" }, { "title": "アプリ起動時広告", @@ -409,7 +409,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/app-open.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/app-open.md" }, { "title": "広告イベント", @@ -653,7 +653,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/events.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/events.md" }, { "title": "テスト", @@ -712,7 +712,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/testing.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/testing.md" }, { "title": "移行", @@ -751,7 +751,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/admob/docs/ja/migration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/admob/docs/ja/migration.md" }, { "title": "API", diff --git a/src/app/generated/projects/capacitor-brotherprint.en.generated.ts b/projects/docs/src/app/generated/projects/capacitor-brotherprint.en.generated.ts similarity index 100% rename from src/app/generated/projects/capacitor-brotherprint.en.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-brotherprint.en.generated.ts diff --git a/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts similarity index 99% rename from src/app/generated/projects/capacitor-brotherprint.ja.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts index 8b09d54..9cbcb3f 100644 --- a/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts @@ -56,7 +56,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-brotherprint/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-brotherprint/docs/ja/readme.md" }, { "title": "インストール", @@ -105,7 +105,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-brotherprint/docs/ja/installation.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-brotherprint/docs/ja/installation.md" }, { "title": "Search", @@ -169,7 +169,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-brotherprint/docs/ja/search.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-brotherprint/docs/ja/search.md" }, { "title": "Print", @@ -193,7 +193,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-brotherprint/docs/ja/print.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-brotherprint/docs/ja/print.md" }, { "title": "Events", @@ -242,7 +242,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-brotherprint/docs/ja/events.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-brotherprint/docs/ja/events.md" }, { "title": "API", diff --git a/src/app/generated/projects/capacitor-codescanner.en.generated.ts b/projects/docs/src/app/generated/projects/capacitor-codescanner.en.generated.ts similarity index 100% rename from src/app/generated/projects/capacitor-codescanner.en.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-codescanner.en.generated.ts diff --git a/src/app/generated/projects/capacitor-codescanner.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-codescanner.ja.generated.ts similarity index 99% rename from src/app/generated/projects/capacitor-codescanner.ja.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-codescanner.ja.generated.ts index b33c94a..f65f15b 100644 --- a/src/app/generated/projects/capacitor-codescanner.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-codescanner.ja.generated.ts @@ -66,7 +66,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-codescanner/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-codescanner/docs/ja/readme.md" }, { "title": "CodeScanner", @@ -115,7 +115,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-codescanner/docs/ja/code-scanner.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-codescanner/docs/ja/code-scanner.md" }, { "title": "API", diff --git a/src/app/generated/projects/capacitor-docgen.en.generated.ts b/projects/docs/src/app/generated/projects/capacitor-docgen.en.generated.ts similarity index 99% rename from src/app/generated/projects/capacitor-docgen.en.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-docgen.en.generated.ts index 1b90c29..f68642a 100644 --- a/src/app/generated/projects/capacitor-docgen.en.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-docgen.en.generated.ts @@ -185,7 +185,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-docgen/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-docgen/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/capacitor-docgen.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-docgen.ja.generated.ts similarity index 99% rename from src/app/generated/projects/capacitor-docgen.ja.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-docgen.ja.generated.ts index 6509074..046f84d 100644 --- a/src/app/generated/projects/capacitor-docgen.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-docgen.ja.generated.ts @@ -52,7 +52,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-docgen/docs/ja/getting-started.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-docgen/docs/ja/getting-started.md" }, { "title": "本家との差分", @@ -91,7 +91,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-docgen/docs/ja/upstream-differences.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-docgen/docs/ja/upstream-differences.md" }, { "title": "API", @@ -180,7 +180,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-docgen/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-docgen/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/capacitor-printer.en.generated.ts b/projects/docs/src/app/generated/projects/capacitor-printer.en.generated.ts similarity index 100% rename from src/app/generated/projects/capacitor-printer.en.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-printer.en.generated.ts diff --git a/src/app/generated/projects/capacitor-printer.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-printer.ja.generated.ts similarity index 99% rename from src/app/generated/projects/capacitor-printer.ja.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-printer.ja.generated.ts index ef82b64..2979077 100644 --- a/src/app/generated/projects/capacitor-printer.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-printer.ja.generated.ts @@ -61,7 +61,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-printer/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-printer/docs/ja/readme.md" }, { "title": "PDF", @@ -85,7 +85,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-printer/docs/ja/pdf.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-printer/docs/ja/pdf.md" }, { "title": "Web", @@ -109,7 +109,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-printer/docs/ja/web.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-printer/docs/ja/web.md" }, { "title": "API", diff --git a/src/app/generated/projects/capacitor-screenshot-event.en.generated.ts b/projects/docs/src/app/generated/projects/capacitor-screenshot-event.en.generated.ts similarity index 100% rename from src/app/generated/projects/capacitor-screenshot-event.en.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-screenshot-event.en.generated.ts diff --git a/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts similarity index 99% rename from src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts rename to projects/docs/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts index 2ea45e4..4e3d2c2 100644 --- a/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts @@ -61,7 +61,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-screenshot-event/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-screenshot-event/docs/ja/readme.md" }, { "title": "ScreenshotEvent", @@ -110,7 +110,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/capacitor-screenshot-event/docs/ja/screenshot-event.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/capacitor-screenshot-event/docs/ja/screenshot-event.md" }, { "title": "API", diff --git a/src/app/generated/projects/eslint-plugin-rules.en.generated.ts b/projects/docs/src/app/generated/projects/eslint-plugin-rules.en.generated.ts similarity index 99% rename from src/app/generated/projects/eslint-plugin-rules.en.generated.ts rename to projects/docs/src/app/generated/projects/eslint-plugin-rules.en.generated.ts index 0947fa5..90de746 100644 --- a/src/app/generated/projects/eslint-plugin-rules.en.generated.ts +++ b/projects/docs/src/app/generated/projects/eslint-plugin-rules.en.generated.ts @@ -191,7 +191,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/api.md" }, { "title": "component-property-use-readonly", diff --git a/src/app/generated/projects/eslint-plugin-rules.ja.generated.ts b/projects/docs/src/app/generated/projects/eslint-plugin-rules.ja.generated.ts similarity index 99% rename from src/app/generated/projects/eslint-plugin-rules.ja.generated.ts rename to projects/docs/src/app/generated/projects/eslint-plugin-rules.ja.generated.ts index e3e06bf..bb65adb 100644 --- a/src/app/generated/projects/eslint-plugin-rules.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/eslint-plugin-rules.ja.generated.ts @@ -55,7 +55,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/getting-started.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/getting-started.md" }, { "title": "設定", @@ -84,7 +84,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/configuration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/configuration.md" }, { "title": "移行", @@ -123,7 +123,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/migration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/migration.md" }, { "title": "ルール一覧", @@ -147,7 +147,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules.md" }, { "title": "API", @@ -181,7 +181,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/api.md" }, { "title": "component-property-use-readonly", @@ -235,7 +235,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/component-property-use-readonly.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/component-property-use-readonly.md" }, { "title": "deny-constructor-di", @@ -284,7 +284,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/deny-constructor-di.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-constructor-di.md" }, { "title": "deny-element", @@ -343,7 +343,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/deny-element.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-element.md" }, { "title": "deny-overlay-create", @@ -402,7 +402,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/deny-overlay-create.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-overlay-create.md" }, { "title": "deny-soft-private-modifier", @@ -426,7 +426,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/deny-soft-private-modifier.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-soft-private-modifier.md" }, { "title": "implements-ionic-lifecycle", @@ -475,7 +475,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/implements-ionic-lifecycle.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/implements-ionic-lifecycle.md" }, { "title": "ionic-attr-type-check", @@ -529,7 +529,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/ionic-attr-type-check.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/ionic-attr-type-check.md" }, { "title": "no-component-method-except-lifecycle", @@ -573,7 +573,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/no-component-method-except-lifecycle.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-component-method-except-lifecycle.md" }, { "title": "no-component-writable-signal", @@ -627,7 +627,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/no-component-writable-signal.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-component-writable-signal.md" }, { "title": "no-reactive-forms", @@ -681,7 +681,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/no-reactive-forms.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-reactive-forms.md" }, { "title": "no-template-driven-forms", @@ -740,7 +740,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/no-template-driven-forms.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-template-driven-forms.md" }, { "title": "prefer-disable-handler", @@ -819,7 +819,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/prefer-disable-handler.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-disable-handler.md" }, { "title": "prefer-ionic-standalone", @@ -868,7 +868,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/prefer-ionic-standalone.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-ionic-standalone.md" }, { "title": "prefer-modal-launcher", @@ -937,7 +937,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/prefer-modal-launcher.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-modal-launcher.md" }, { "title": "require-ion-item-group", @@ -991,7 +991,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/require-ion-item-group.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/require-ion-item-group.md" }, { "title": "require-viewmodel", @@ -1075,7 +1075,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/require-viewmodel.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/require-viewmodel.md" }, { "title": "restrict-try-block", @@ -1154,7 +1154,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/restrict-try-block.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/restrict-try-block.md" }, { "title": "signal-use-as-signal-template", @@ -1213,7 +1213,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal-template.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal-template.md" }, { "title": "signal-use-as-signal", @@ -1272,7 +1272,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal.md" } ] } as const; diff --git a/src/app/generated/projects/facebook-login.en.generated.ts b/projects/docs/src/app/generated/projects/facebook-login.en.generated.ts similarity index 100% rename from src/app/generated/projects/facebook-login.en.generated.ts rename to projects/docs/src/app/generated/projects/facebook-login.en.generated.ts diff --git a/src/app/generated/projects/facebook-login.ja.generated.ts b/projects/docs/src/app/generated/projects/facebook-login.ja.generated.ts similarity index 99% rename from src/app/generated/projects/facebook-login.ja.generated.ts rename to projects/docs/src/app/generated/projects/facebook-login.ja.generated.ts index 55d2194..3a5b1c1 100644 --- a/src/app/generated/projects/facebook-login.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/facebook-login.ja.generated.ts @@ -70,7 +70,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/facebook-login/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/facebook-login/docs/ja/readme.md" }, { "title": "設定", @@ -109,7 +109,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/facebook-login/docs/ja/configuration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/facebook-login/docs/ja/configuration.md" }, { "title": "認証", @@ -158,7 +158,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/facebook-login/docs/ja/authentication.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/facebook-login/docs/ja/authentication.md" }, { "title": "App Events", @@ -187,7 +187,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/facebook-login/docs/ja/app-events.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/facebook-login/docs/ja/app-events.md" }, { "title": "API", diff --git a/src/app/generated/projects/ionic-angular-collect-icons.en.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-collect-icons.en.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-angular-collect-icons.en.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-collect-icons.en.generated.ts index e81dd9e..c643ae5 100644 --- a/src/app/generated/projects/ionic-angular-collect-icons.en.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-collect-icons.en.generated.ts @@ -259,7 +259,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-angular-collect-icons.ja.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-collect-icons.ja.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-angular-collect-icons.ja.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-collect-icons.ja.generated.ts index bdd0343..5bd13e6 100644 --- a/src/app/generated/projects/ionic-angular-collect-icons.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-collect-icons.ja.generated.ts @@ -71,7 +71,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/ja/readme.md" }, { "title": "初期化", @@ -110,7 +110,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/ja/initialize.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/ja/initialize.md" }, { "title": "使い方", @@ -129,7 +129,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/ja/usage.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/ja/usage.md" }, { "title": "CLI オプション", @@ -168,7 +168,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/ja/options.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/ja/options.md" }, { "title": "FAQ", @@ -181,7 +181,7 @@ export const PROJECT = { "headings": [], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/ja/faq.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/ja/faq.md" }, { "title": "移行", @@ -235,7 +235,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/ja/migration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/ja/migration.md" }, { "title": "CLI API", @@ -259,7 +259,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-collect-icons/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-collect-icons/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-angular-kit.en.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-kit.en.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-angular-kit.en.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-kit.en.generated.ts index 8870d5d..07a71b8 100644 --- a/src/app/generated/projects/ionic-angular-kit.en.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-kit.en.generated.ts @@ -240,7 +240,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-kit/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-kit/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-angular-kit.ja.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-kit.ja.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-angular-kit.ja.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-kit.ja.generated.ts index 9cc068b..9b34c14 100644 --- a/src/app/generated/projects/ionic-angular-kit.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-kit.ja.generated.ts @@ -60,7 +60,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-kit/docs/ja/getting-started.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-kit/docs/ja/getting-started.md" }, { "title": "Storage・Overlay", @@ -84,7 +84,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-kit/docs/ja/storage-overlays.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-kit/docs/ja/storage-overlays.md" }, { "title": "認証・HTTP", @@ -108,7 +108,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-kit/docs/ja/auth-http.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-kit/docs/ja/auth-http.md" }, { "title": "Offline・Realtime", @@ -132,7 +132,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-kit/docs/ja/offline-realtime.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-kit/docs/ja/offline-realtime.md" }, { "title": "任意機能", @@ -166,7 +166,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-kit/docs/ja/optional-features.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-kit/docs/ja/optional-features.md" }, { "title": "API", @@ -235,7 +235,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-kit/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-kit/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-angular-photo-editor.en.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-photo-editor.en.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-angular-photo-editor.en.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-photo-editor.en.generated.ts index 082943c..fb4e866 100644 --- a/src/app/generated/projects/ionic-angular-photo-editor.en.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-photo-editor.en.generated.ts @@ -316,7 +316,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-photo-editor/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-photo-editor/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-angular-photo-editor.ja.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-photo-editor.ja.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-angular-photo-editor.ja.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-photo-editor.ja.generated.ts index b2c9e1c..5004216 100644 --- a/src/app/generated/projects/ionic-angular-photo-editor.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-photo-editor.ja.generated.ts @@ -71,7 +71,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-photo-editor/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-photo-editor/docs/ja/readme.md" }, { "title": "テーマ", @@ -95,7 +95,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-photo-editor/docs/ja/theme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-photo-editor/docs/ja/theme.md" }, { "title": "PhotoFileService", @@ -114,7 +114,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-photo-editor/docs/ja/photo-file.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-photo-editor/docs/ja/photo-file.md" }, { "title": "Photo Editor", @@ -153,7 +153,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-photo-editor/docs/ja/editor.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-photo-editor/docs/ja/editor.md" }, { "title": "Photo Viewer", @@ -207,7 +207,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-photo-editor/docs/ja/viewer.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-photo-editor/docs/ja/viewer.md" }, { "title": "API", @@ -316,7 +316,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-photo-editor/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-photo-editor/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-angular-scroll-header.en.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-scroll-header.en.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-angular-scroll-header.en.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-scroll-header.en.generated.ts index 20824c6..3335905 100644 --- a/src/app/generated/projects/ionic-angular-scroll-header.en.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-scroll-header.en.generated.ts @@ -161,7 +161,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-scroll-header/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-scroll-header/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-angular-scroll-header.ja.generated.ts b/projects/docs/src/app/generated/projects/ionic-angular-scroll-header.ja.generated.ts similarity index 98% rename from src/app/generated/projects/ionic-angular-scroll-header.ja.generated.ts rename to projects/docs/src/app/generated/projects/ionic-angular-scroll-header.ja.generated.ts index 9f334ab..9a70ba8 100644 --- a/src/app/generated/projects/ionic-angular-scroll-header.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-angular-scroll-header.ja.generated.ts @@ -71,7 +71,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-scroll-header/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-scroll-header/docs/ja/readme.md" }, { "title": "IonContent", @@ -84,7 +84,7 @@ export const PROJECT = { "headings": [], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-scroll-header/docs/ja/ion-content.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-scroll-header/docs/ja/ion-content.md" }, { "title": "Virtual Scroll", @@ -103,7 +103,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-scroll-header/docs/ja/virtual-scroll.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-scroll-header/docs/ja/virtual-scroll.md" }, { "title": "Safe Area", @@ -127,7 +127,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-scroll-header/docs/ja/safe-area.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-scroll-header/docs/ja/safe-area.md" }, { "title": "API", @@ -161,7 +161,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-angular-scroll-header/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-angular-scroll-header/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-theme-ios26.en.generated.ts b/projects/docs/src/app/generated/projects/ionic-theme-ios26.en.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-theme-ios26.en.generated.ts rename to projects/docs/src/app/generated/projects/ionic-theme-ios26.en.generated.ts index 53b7319..10afa58 100644 --- a/src/app/generated/projects/ionic-theme-ios26.en.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-theme-ios26.en.generated.ts @@ -359,7 +359,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-theme-ios26.ja.generated.ts b/projects/docs/src/app/generated/projects/ionic-theme-ios26.ja.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-theme-ios26.ja.generated.ts rename to projects/docs/src/app/generated/projects/ionic-theme-ios26.ja.generated.ts index 36ecd85..6fd2553 100644 --- a/src/app/generated/projects/ionic-theme-ios26.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-theme-ios26.ja.generated.ts @@ -66,7 +66,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/readme.md" }, { "title": "ion-item-groupの使用方法", @@ -95,7 +95,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/using-ion-item-group.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/using-ion-item-group.md" }, { "title": "機能", @@ -134,7 +134,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/features.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/features.md" }, { "title": "特別なマークアップとクラス", @@ -183,7 +183,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/special-markup.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/special-markup.md" }, { "title": "実験的なアニメーション", @@ -207,7 +207,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/experimental-animation.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/experimental-animation.md" }, { "title": "iOS 18", @@ -226,7 +226,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/ios-18.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/ios-18.md" }, { "title": "移行", @@ -280,7 +280,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/migration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/migration.md" }, { "title": "API", @@ -359,7 +359,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-ios26/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-ios26/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-theme-md3.en.generated.ts b/projects/docs/src/app/generated/projects/ionic-theme-md3.en.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-theme-md3.en.generated.ts rename to projects/docs/src/app/generated/projects/ionic-theme-md3.en.generated.ts index 7221063..850f868 100644 --- a/src/app/generated/projects/ionic-theme-md3.en.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-theme-md3.en.generated.ts @@ -177,7 +177,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-md3/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-md3/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/ionic-theme-md3.ja.generated.ts b/projects/docs/src/app/generated/projects/ionic-theme-md3.ja.generated.ts similarity index 99% rename from src/app/generated/projects/ionic-theme-md3.ja.generated.ts rename to projects/docs/src/app/generated/projects/ionic-theme-md3.ja.generated.ts index 64d6598..d8db1be 100644 --- a/src/app/generated/projects/ionic-theme-md3.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/ionic-theme-md3.ja.generated.ts @@ -71,7 +71,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-md3/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-md3/docs/ja/readme.md" }, { "title": "特別なマークアップ", @@ -105,7 +105,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-md3/docs/ja/special-markup.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-md3/docs/ja/special-markup.md" }, { "title": "ion-item-groupの使用方法", @@ -129,7 +129,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-md3/docs/ja/using-ion-item-group.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-md3/docs/ja/using-ion-item-group.md" }, { "title": "移行", @@ -153,7 +153,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-md3/docs/ja/migration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-md3/docs/ja/migration.md" }, { "title": "API", @@ -177,7 +177,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ionic-theme-md3/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ionic-theme-md3/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/ngx-cdk-scroll-strategies.en.generated.ts b/projects/docs/src/app/generated/projects/ngx-cdk-scroll-strategies.en.generated.ts similarity index 99% rename from src/app/generated/projects/ngx-cdk-scroll-strategies.en.generated.ts rename to projects/docs/src/app/generated/projects/ngx-cdk-scroll-strategies.en.generated.ts index 4cce491..822a17f 100644 --- a/src/app/generated/projects/ngx-cdk-scroll-strategies.en.generated.ts +++ b/projects/docs/src/app/generated/projects/ngx-cdk-scroll-strategies.en.generated.ts @@ -204,7 +204,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ngx-cdk-scroll-strategies/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ngx-cdk-scroll-strategies/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/ngx-cdk-scroll-strategies.ja.generated.ts b/projects/docs/src/app/generated/projects/ngx-cdk-scroll-strategies.ja.generated.ts similarity index 99% rename from src/app/generated/projects/ngx-cdk-scroll-strategies.ja.generated.ts rename to projects/docs/src/app/generated/projects/ngx-cdk-scroll-strategies.ja.generated.ts index 34d4677..25baaac 100644 --- a/src/app/generated/projects/ngx-cdk-scroll-strategies.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/ngx-cdk-scroll-strategies.ja.generated.ts @@ -71,7 +71,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ngx-cdk-scroll-strategies/docs/ja/readme.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/readme.md" }, { "title": "シンプルな使い方", @@ -84,7 +84,7 @@ export const PROJECT = { "headings": [], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ngx-cdk-scroll-strategies/docs/ja/simple.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/simple.md" }, { "title": "応用的な使い方", @@ -97,7 +97,7 @@ export const PROJECT = { "headings": [], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ngx-cdk-scroll-strategies/docs/ja/advanced.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/advanced.md" }, { "title": "リバーススクロール", @@ -116,7 +116,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ngx-cdk-scroll-strategies/docs/ja/reverse.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/reverse.md" }, { "title": "FAQ", @@ -135,7 +135,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ngx-cdk-scroll-strategies/docs/ja/faq.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/faq.md" }, { "title": "API", @@ -204,7 +204,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/ngx-cdk-scroll-strategies/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/stripe-identity.en.generated.ts b/projects/docs/src/app/generated/projects/stripe-identity.en.generated.ts similarity index 99% rename from src/app/generated/projects/stripe-identity.en.generated.ts rename to projects/docs/src/app/generated/projects/stripe-identity.en.generated.ts index 73bd80a..3d10e95 100644 --- a/src/app/generated/projects/stripe-identity.en.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-identity.en.generated.ts @@ -367,7 +367,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-identity/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-identity/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/stripe-identity.ja.generated.ts b/projects/docs/src/app/generated/projects/stripe-identity.ja.generated.ts similarity index 99% rename from src/app/generated/projects/stripe-identity.ja.generated.ts rename to projects/docs/src/app/generated/projects/stripe-identity.ja.generated.ts index a6e9270..dc453da 100644 --- a/src/app/generated/projects/stripe-identity.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-identity.ja.generated.ts @@ -56,7 +56,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-identity/docs/ja/configuration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-identity/docs/ja/configuration.md" }, { "title": "本人確認シート", @@ -268,7 +268,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-identity/docs/ja/identity-verification-sheet.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-identity/docs/ja/identity-verification-sheet.md" }, { "title": "API", @@ -367,7 +367,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-identity/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-identity/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/stripe-terminal.en.generated.ts b/projects/docs/src/app/generated/projects/stripe-terminal.en.generated.ts similarity index 99% rename from src/app/generated/projects/stripe-terminal.en.generated.ts rename to projects/docs/src/app/generated/projects/stripe-terminal.en.generated.ts index 7b4bf7f..3d0c685 100644 --- a/src/app/generated/projects/stripe-terminal.en.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-terminal.en.generated.ts @@ -1270,7 +1270,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-terminal/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-terminal/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/stripe-terminal.ja.generated.ts b/projects/docs/src/app/generated/projects/stripe-terminal.ja.generated.ts similarity index 99% rename from src/app/generated/projects/stripe-terminal.ja.generated.ts rename to projects/docs/src/app/generated/projects/stripe-terminal.ja.generated.ts index 3698e3a..d25887d 100644 --- a/src/app/generated/projects/stripe-terminal.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-terminal.ja.generated.ts @@ -75,7 +75,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-terminal/docs/ja/configuration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-terminal/docs/ja/configuration.md" }, { "title": "支払いを受け付ける", @@ -394,7 +394,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-terminal/docs/ja/collect-a-payment.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-terminal/docs/ja/collect-a-payment.md" }, { "title": "リーダーのライフサイクル", @@ -682,7 +682,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-terminal/docs/ja/reader-lifecycle.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-terminal/docs/ja/reader-lifecycle.md" }, { "title": "Tap to Pay", @@ -886,7 +886,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-terminal/docs/ja/tap-to-pay.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-terminal/docs/ja/tap-to-pay.md" }, { "title": "API", @@ -1270,7 +1270,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe-terminal/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe-terminal/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/stripe.en.generated.ts b/projects/docs/src/app/generated/projects/stripe.en.generated.ts similarity index 99% rename from src/app/generated/projects/stripe.en.generated.ts rename to projects/docs/src/app/generated/projects/stripe.en.generated.ts index 613dfb2..dfcb7b2 100644 --- a/src/app/generated/projects/stripe.en.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe.en.generated.ts @@ -1552,7 +1552,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/api.md" } ] } as const; diff --git a/src/app/generated/projects/stripe.ja.generated.ts b/projects/docs/src/app/generated/projects/stripe.ja.generated.ts similarity index 99% rename from src/app/generated/projects/stripe.ja.generated.ts rename to projects/docs/src/app/generated/projects/stripe.ja.generated.ts index e0b9588..afd0308 100644 --- a/src/app/generated/projects/stripe.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe.ja.generated.ts @@ -64,7 +64,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/configuration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/configuration.md" }, { "title": "Vanilla JS クイックスタート", @@ -77,7 +77,7 @@ export const PROJECT = { "headings": [], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/vanilla-js.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/vanilla-js.md" }, { "title": "Angular クイックスタート", @@ -96,7 +96,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/angular.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/angular.md" }, { "title": "React クイックスタート", @@ -115,7 +115,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/react.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/react.md" }, { "title": "イベントリスナー", @@ -299,7 +299,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/learn/event-listeners.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/learn/event-listeners.md" }, { "title": "サーバー連携", @@ -333,7 +333,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/server-integration.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/server-integration.md" }, { "title": "プロジェクトで初期化する", @@ -397,7 +397,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/initialize.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/initialize.md" }, { "title": "PaymentSheet", @@ -528,7 +528,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/payment-sheet.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/payment-sheet.md" }, { "title": "PaymentFlow", @@ -683,7 +683,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/payment-flow.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/payment-flow.md" }, { "title": "Apple Pay", @@ -877,7 +877,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/apple-pay.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/apple-pay.md" }, { "title": "Google Pay", @@ -1198,7 +1198,7 @@ export const PROJECT = { } } ], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/google-pay.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/google-pay.md" }, { "title": "API", @@ -1552,7 +1552,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/stripe/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/stripe/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/projects/workers-hono-kit.en.generated.ts b/projects/docs/src/app/generated/projects/workers-hono-kit.en.generated.ts similarity index 100% rename from src/app/generated/projects/workers-hono-kit.en.generated.ts rename to projects/docs/src/app/generated/projects/workers-hono-kit.en.generated.ts diff --git a/src/app/generated/projects/workers-hono-kit.ja.generated.ts b/projects/docs/src/app/generated/projects/workers-hono-kit.ja.generated.ts similarity index 98% rename from src/app/generated/projects/workers-hono-kit.ja.generated.ts rename to projects/docs/src/app/generated/projects/workers-hono-kit.ja.generated.ts index 60a1be7..d6ee8b4 100644 --- a/src/app/generated/projects/workers-hono-kit.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/workers-hono-kit.ja.generated.ts @@ -50,7 +50,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/workers-hono-kit/docs/ja/getting-started.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/workers-hono-kit/docs/ja/getting-started.md" }, { "title": "HTTP・認証", @@ -84,7 +84,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/workers-hono-kit/docs/ja/http-auth.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/workers-hono-kit/docs/ja/http-auth.md" }, { "title": "データ層", @@ -113,7 +113,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/workers-hono-kit/docs/ja/data-layer.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/workers-hono-kit/docs/ja/data-layer.md" }, { "title": "Realtime・Offline", @@ -137,7 +137,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/workers-hono-kit/docs/ja/realtime-offline.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/workers-hono-kit/docs/ja/realtime-offline.md" }, { "title": "テスト・運用", @@ -171,7 +171,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/workers-hono-kit/docs/ja/testing-operations.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/workers-hono-kit/docs/ja/testing-operations.md" }, { "title": "API", @@ -220,7 +220,7 @@ export const PROJECT = { ], "codes": [], "scrollMap": [], - "editUrl": "https://github.com/rdlabo-dev/website/edit/main/src/workers-hono-kit/docs/ja/api.md" + "editUrl": "https://github.com/rdlabo-dev/website/edit/main/projects/docs/src/workers-hono-kit/docs/ja/api.md" } ] } as const; diff --git a/src/app/generated/sponsors.generated.ts b/projects/docs/src/app/generated/sponsors.generated.ts similarity index 100% rename from src/app/generated/sponsors.generated.ts rename to projects/docs/src/app/generated/sponsors.generated.ts diff --git a/src/app/locale-path.ts b/projects/docs/src/app/locale-path.ts similarity index 100% rename from src/app/locale-path.ts rename to projects/docs/src/app/locale-path.ts diff --git a/src/app/site-config.ts b/projects/docs/src/app/site-config.ts similarity index 100% rename from src/app/site-config.ts rename to projects/docs/src/app/site-config.ts diff --git a/src/capacitor-brotherprint/docs/ja/events.md b/projects/docs/src/capacitor-brotherprint/docs/ja/events.md similarity index 100% rename from src/capacitor-brotherprint/docs/ja/events.md rename to projects/docs/src/capacitor-brotherprint/docs/ja/events.md diff --git a/src/capacitor-brotherprint/docs/ja/installation.md b/projects/docs/src/capacitor-brotherprint/docs/ja/installation.md similarity index 100% rename from src/capacitor-brotherprint/docs/ja/installation.md rename to projects/docs/src/capacitor-brotherprint/docs/ja/installation.md diff --git a/src/capacitor-brotherprint/docs/ja/print.md b/projects/docs/src/capacitor-brotherprint/docs/ja/print.md similarity index 100% rename from src/capacitor-brotherprint/docs/ja/print.md rename to projects/docs/src/capacitor-brotherprint/docs/ja/print.md diff --git a/src/capacitor-brotherprint/docs/ja/readme.md b/projects/docs/src/capacitor-brotherprint/docs/ja/readme.md similarity index 100% rename from src/capacitor-brotherprint/docs/ja/readme.md rename to projects/docs/src/capacitor-brotherprint/docs/ja/readme.md diff --git a/src/capacitor-brotherprint/docs/ja/search.md b/projects/docs/src/capacitor-brotherprint/docs/ja/search.md similarity index 100% rename from src/capacitor-brotherprint/docs/ja/search.md rename to projects/docs/src/capacitor-brotherprint/docs/ja/search.md diff --git a/src/capacitor-codescanner/docs/ja/code-scanner.md b/projects/docs/src/capacitor-codescanner/docs/ja/code-scanner.md similarity index 100% rename from src/capacitor-codescanner/docs/ja/code-scanner.md rename to projects/docs/src/capacitor-codescanner/docs/ja/code-scanner.md diff --git a/src/capacitor-codescanner/docs/ja/readme.md b/projects/docs/src/capacitor-codescanner/docs/ja/readme.md similarity index 100% rename from src/capacitor-codescanner/docs/ja/readme.md rename to projects/docs/src/capacitor-codescanner/docs/ja/readme.md diff --git a/src/capacitor-docgen/docs/api.md b/projects/docs/src/capacitor-docgen/docs/api.md similarity index 100% rename from src/capacitor-docgen/docs/api.md rename to projects/docs/src/capacitor-docgen/docs/api.md diff --git a/src/capacitor-docgen/docs/getting-started.md b/projects/docs/src/capacitor-docgen/docs/getting-started.md similarity index 100% rename from src/capacitor-docgen/docs/getting-started.md rename to projects/docs/src/capacitor-docgen/docs/getting-started.md diff --git a/src/capacitor-docgen/docs/ja/api.md b/projects/docs/src/capacitor-docgen/docs/ja/api.md similarity index 100% rename from src/capacitor-docgen/docs/ja/api.md rename to projects/docs/src/capacitor-docgen/docs/ja/api.md diff --git a/src/capacitor-docgen/docs/ja/getting-started.md b/projects/docs/src/capacitor-docgen/docs/ja/getting-started.md similarity index 100% rename from src/capacitor-docgen/docs/ja/getting-started.md rename to projects/docs/src/capacitor-docgen/docs/ja/getting-started.md diff --git a/src/capacitor-docgen/docs/ja/upstream-differences.md b/projects/docs/src/capacitor-docgen/docs/ja/upstream-differences.md similarity index 100% rename from src/capacitor-docgen/docs/ja/upstream-differences.md rename to projects/docs/src/capacitor-docgen/docs/ja/upstream-differences.md diff --git a/src/capacitor-docgen/docs/upstream-differences.md b/projects/docs/src/capacitor-docgen/docs/upstream-differences.md similarity index 100% rename from src/capacitor-docgen/docs/upstream-differences.md rename to projects/docs/src/capacitor-docgen/docs/upstream-differences.md diff --git a/src/capacitor-printer/docs/ja/pdf.md b/projects/docs/src/capacitor-printer/docs/ja/pdf.md similarity index 100% rename from src/capacitor-printer/docs/ja/pdf.md rename to projects/docs/src/capacitor-printer/docs/ja/pdf.md diff --git a/src/capacitor-printer/docs/ja/readme.md b/projects/docs/src/capacitor-printer/docs/ja/readme.md similarity index 100% rename from src/capacitor-printer/docs/ja/readme.md rename to projects/docs/src/capacitor-printer/docs/ja/readme.md diff --git a/src/capacitor-printer/docs/ja/web.md b/projects/docs/src/capacitor-printer/docs/ja/web.md similarity index 100% rename from src/capacitor-printer/docs/ja/web.md rename to projects/docs/src/capacitor-printer/docs/ja/web.md diff --git a/src/capacitor-screenshot-event/docs/ja/readme.md b/projects/docs/src/capacitor-screenshot-event/docs/ja/readme.md similarity index 100% rename from src/capacitor-screenshot-event/docs/ja/readme.md rename to projects/docs/src/capacitor-screenshot-event/docs/ja/readme.md diff --git a/src/capacitor-screenshot-event/docs/ja/screenshot-event.md b/projects/docs/src/capacitor-screenshot-event/docs/ja/screenshot-event.md similarity index 100% rename from src/capacitor-screenshot-event/docs/ja/screenshot-event.md rename to projects/docs/src/capacitor-screenshot-event/docs/ja/screenshot-event.md diff --git a/src/eslint-plugin-rules/docs/api.md b/projects/docs/src/eslint-plugin-rules/docs/api.md similarity index 100% rename from src/eslint-plugin-rules/docs/api.md rename to projects/docs/src/eslint-plugin-rules/docs/api.md diff --git a/src/eslint-plugin-rules/docs/configuration.md b/projects/docs/src/eslint-plugin-rules/docs/configuration.md similarity index 100% rename from src/eslint-plugin-rules/docs/configuration.md rename to projects/docs/src/eslint-plugin-rules/docs/configuration.md diff --git a/src/eslint-plugin-rules/docs/getting-started.md b/projects/docs/src/eslint-plugin-rules/docs/getting-started.md similarity index 100% rename from src/eslint-plugin-rules/docs/getting-started.md rename to projects/docs/src/eslint-plugin-rules/docs/getting-started.md diff --git a/src/eslint-plugin-rules/docs/ja/api.md b/projects/docs/src/eslint-plugin-rules/docs/ja/api.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/api.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/api.md diff --git a/src/eslint-plugin-rules/docs/ja/configuration.md b/projects/docs/src/eslint-plugin-rules/docs/ja/configuration.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/configuration.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/configuration.md diff --git a/src/eslint-plugin-rules/docs/ja/getting-started.md b/projects/docs/src/eslint-plugin-rules/docs/ja/getting-started.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/getting-started.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/getting-started.md diff --git a/src/eslint-plugin-rules/docs/ja/migration.md b/projects/docs/src/eslint-plugin-rules/docs/ja/migration.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/migration.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/migration.md diff --git a/src/eslint-plugin-rules/docs/ja/rules.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/component-property-use-readonly.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/component-property-use-readonly.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/component-property-use-readonly.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/component-property-use-readonly.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/deny-constructor-di.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-constructor-di.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/deny-constructor-di.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-constructor-di.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/deny-element.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-element.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/deny-element.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-element.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/deny-overlay-create.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-overlay-create.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/deny-overlay-create.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-overlay-create.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/deny-soft-private-modifier.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-soft-private-modifier.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/deny-soft-private-modifier.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/deny-soft-private-modifier.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/implements-ionic-lifecycle.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/implements-ionic-lifecycle.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/implements-ionic-lifecycle.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/implements-ionic-lifecycle.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/ionic-attr-type-check.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/ionic-attr-type-check.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/ionic-attr-type-check.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/ionic-attr-type-check.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/no-component-method-except-lifecycle.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-component-method-except-lifecycle.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/no-component-method-except-lifecycle.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-component-method-except-lifecycle.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/no-component-writable-signal.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-component-writable-signal.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/no-component-writable-signal.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-component-writable-signal.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/no-reactive-forms.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-reactive-forms.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/no-reactive-forms.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-reactive-forms.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/no-template-driven-forms.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-template-driven-forms.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/no-template-driven-forms.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/no-template-driven-forms.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/prefer-disable-handler.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-disable-handler.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/prefer-disable-handler.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-disable-handler.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/prefer-ionic-standalone.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-ionic-standalone.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/prefer-ionic-standalone.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-ionic-standalone.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/prefer-modal-launcher.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-modal-launcher.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/prefer-modal-launcher.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/prefer-modal-launcher.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/require-ion-item-group.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/require-ion-item-group.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/require-ion-item-group.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/require-ion-item-group.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/require-viewmodel.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/require-viewmodel.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/require-viewmodel.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/require-viewmodel.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/restrict-try-block.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/restrict-try-block.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/restrict-try-block.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/restrict-try-block.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal-template.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal-template.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal-template.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal-template.md diff --git a/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal.md b/projects/docs/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal.md similarity index 100% rename from src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal.md rename to projects/docs/src/eslint-plugin-rules/docs/ja/rules/signal-use-as-signal.md diff --git a/src/eslint-plugin-rules/docs/rules.md b/projects/docs/src/eslint-plugin-rules/docs/rules.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules.md rename to projects/docs/src/eslint-plugin-rules/docs/rules.md diff --git a/src/eslint-plugin-rules/docs/rules/component-property-use-readonly.md b/projects/docs/src/eslint-plugin-rules/docs/rules/component-property-use-readonly.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/component-property-use-readonly.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/component-property-use-readonly.md diff --git a/src/eslint-plugin-rules/docs/rules/deny-constructor-di.md b/projects/docs/src/eslint-plugin-rules/docs/rules/deny-constructor-di.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/deny-constructor-di.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/deny-constructor-di.md diff --git a/src/eslint-plugin-rules/docs/rules/deny-element.md b/projects/docs/src/eslint-plugin-rules/docs/rules/deny-element.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/deny-element.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/deny-element.md diff --git a/src/eslint-plugin-rules/docs/rules/deny-import-from-ionic-module.md b/projects/docs/src/eslint-plugin-rules/docs/rules/deny-import-from-ionic-module.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/deny-import-from-ionic-module.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/deny-import-from-ionic-module.md diff --git a/src/eslint-plugin-rules/docs/rules/deny-overlay-create.md b/projects/docs/src/eslint-plugin-rules/docs/rules/deny-overlay-create.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/deny-overlay-create.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/deny-overlay-create.md diff --git a/src/eslint-plugin-rules/docs/rules/deny-soft-private-modifier.md b/projects/docs/src/eslint-plugin-rules/docs/rules/deny-soft-private-modifier.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/deny-soft-private-modifier.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/deny-soft-private-modifier.md diff --git a/src/eslint-plugin-rules/docs/rules/implements-ionic-lifecycle.md b/projects/docs/src/eslint-plugin-rules/docs/rules/implements-ionic-lifecycle.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/implements-ionic-lifecycle.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/implements-ionic-lifecycle.md diff --git a/src/eslint-plugin-rules/docs/rules/ionic-attr-type-check.md b/projects/docs/src/eslint-plugin-rules/docs/rules/ionic-attr-type-check.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/ionic-attr-type-check.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/ionic-attr-type-check.md diff --git a/src/eslint-plugin-rules/docs/rules/no-component-method-except-lifecycle.md b/projects/docs/src/eslint-plugin-rules/docs/rules/no-component-method-except-lifecycle.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/no-component-method-except-lifecycle.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/no-component-method-except-lifecycle.md diff --git a/src/eslint-plugin-rules/docs/rules/no-component-writable-signal.md b/projects/docs/src/eslint-plugin-rules/docs/rules/no-component-writable-signal.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/no-component-writable-signal.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/no-component-writable-signal.md diff --git a/src/eslint-plugin-rules/docs/rules/no-reactive-forms.md b/projects/docs/src/eslint-plugin-rules/docs/rules/no-reactive-forms.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/no-reactive-forms.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/no-reactive-forms.md diff --git a/src/eslint-plugin-rules/docs/rules/no-template-driven-forms.md b/projects/docs/src/eslint-plugin-rules/docs/rules/no-template-driven-forms.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/no-template-driven-forms.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/no-template-driven-forms.md diff --git a/src/eslint-plugin-rules/docs/rules/prefer-disable-handler.md b/projects/docs/src/eslint-plugin-rules/docs/rules/prefer-disable-handler.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/prefer-disable-handler.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/prefer-disable-handler.md diff --git a/src/eslint-plugin-rules/docs/rules/prefer-modal-launcher.md b/projects/docs/src/eslint-plugin-rules/docs/rules/prefer-modal-launcher.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/prefer-modal-launcher.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/prefer-modal-launcher.md diff --git a/src/eslint-plugin-rules/docs/rules/require-viewmodel.md b/projects/docs/src/eslint-plugin-rules/docs/rules/require-viewmodel.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/require-viewmodel.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/require-viewmodel.md diff --git a/src/eslint-plugin-rules/docs/rules/restrict-try-block.md b/projects/docs/src/eslint-plugin-rules/docs/rules/restrict-try-block.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/restrict-try-block.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/restrict-try-block.md diff --git a/src/eslint-plugin-rules/docs/rules/signal-use-as-signal-template.md b/projects/docs/src/eslint-plugin-rules/docs/rules/signal-use-as-signal-template.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/signal-use-as-signal-template.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/signal-use-as-signal-template.md diff --git a/src/eslint-plugin-rules/docs/rules/signal-use-as-signal.md b/projects/docs/src/eslint-plugin-rules/docs/rules/signal-use-as-signal.md similarity index 100% rename from src/eslint-plugin-rules/docs/rules/signal-use-as-signal.md rename to projects/docs/src/eslint-plugin-rules/docs/rules/signal-use-as-signal.md diff --git a/src/facebook-login/docs/ja/app-events.md b/projects/docs/src/facebook-login/docs/ja/app-events.md similarity index 100% rename from src/facebook-login/docs/ja/app-events.md rename to projects/docs/src/facebook-login/docs/ja/app-events.md diff --git a/src/facebook-login/docs/ja/authentication.md b/projects/docs/src/facebook-login/docs/ja/authentication.md similarity index 100% rename from src/facebook-login/docs/ja/authentication.md rename to projects/docs/src/facebook-login/docs/ja/authentication.md diff --git a/src/facebook-login/docs/ja/configuration.md b/projects/docs/src/facebook-login/docs/ja/configuration.md similarity index 100% rename from src/facebook-login/docs/ja/configuration.md rename to projects/docs/src/facebook-login/docs/ja/configuration.md diff --git a/src/facebook-login/docs/ja/readme.md b/projects/docs/src/facebook-login/docs/ja/readme.md similarity index 100% rename from src/facebook-login/docs/ja/readme.md rename to projects/docs/src/facebook-login/docs/ja/readme.md diff --git a/src/index.html b/projects/docs/src/index.html similarity index 100% rename from src/index.html rename to projects/docs/src/index.html diff --git a/src/ionic-angular-collect-icons/docs/api.md b/projects/docs/src/ionic-angular-collect-icons/docs/api.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/api.md rename to projects/docs/src/ionic-angular-collect-icons/docs/api.md diff --git a/src/ionic-angular-collect-icons/docs/faq.md b/projects/docs/src/ionic-angular-collect-icons/docs/faq.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/faq.md rename to projects/docs/src/ionic-angular-collect-icons/docs/faq.md diff --git a/src/ionic-angular-collect-icons/docs/initialize.md b/projects/docs/src/ionic-angular-collect-icons/docs/initialize.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/initialize.md rename to projects/docs/src/ionic-angular-collect-icons/docs/initialize.md diff --git a/src/ionic-angular-collect-icons/docs/ja/api.md b/projects/docs/src/ionic-angular-collect-icons/docs/ja/api.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/ja/api.md rename to projects/docs/src/ionic-angular-collect-icons/docs/ja/api.md diff --git a/src/ionic-angular-collect-icons/docs/ja/faq.md b/projects/docs/src/ionic-angular-collect-icons/docs/ja/faq.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/ja/faq.md rename to projects/docs/src/ionic-angular-collect-icons/docs/ja/faq.md diff --git a/src/ionic-angular-collect-icons/docs/ja/initialize.md b/projects/docs/src/ionic-angular-collect-icons/docs/ja/initialize.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/ja/initialize.md rename to projects/docs/src/ionic-angular-collect-icons/docs/ja/initialize.md diff --git a/src/ionic-angular-collect-icons/docs/ja/migration.md b/projects/docs/src/ionic-angular-collect-icons/docs/ja/migration.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/ja/migration.md rename to projects/docs/src/ionic-angular-collect-icons/docs/ja/migration.md diff --git a/src/ionic-angular-collect-icons/docs/ja/options.md b/projects/docs/src/ionic-angular-collect-icons/docs/ja/options.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/ja/options.md rename to projects/docs/src/ionic-angular-collect-icons/docs/ja/options.md diff --git a/src/ionic-angular-collect-icons/docs/ja/readme.md b/projects/docs/src/ionic-angular-collect-icons/docs/ja/readme.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/ja/readme.md rename to projects/docs/src/ionic-angular-collect-icons/docs/ja/readme.md diff --git a/src/ionic-angular-collect-icons/docs/ja/usage.md b/projects/docs/src/ionic-angular-collect-icons/docs/ja/usage.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/ja/usage.md rename to projects/docs/src/ionic-angular-collect-icons/docs/ja/usage.md diff --git a/src/ionic-angular-collect-icons/docs/options.md b/projects/docs/src/ionic-angular-collect-icons/docs/options.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/options.md rename to projects/docs/src/ionic-angular-collect-icons/docs/options.md diff --git a/src/ionic-angular-collect-icons/docs/readme.md b/projects/docs/src/ionic-angular-collect-icons/docs/readme.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/readme.md rename to projects/docs/src/ionic-angular-collect-icons/docs/readme.md diff --git a/src/ionic-angular-collect-icons/docs/usage.md b/projects/docs/src/ionic-angular-collect-icons/docs/usage.md similarity index 100% rename from src/ionic-angular-collect-icons/docs/usage.md rename to projects/docs/src/ionic-angular-collect-icons/docs/usage.md diff --git a/src/ionic-angular-kit/docs/api.md b/projects/docs/src/ionic-angular-kit/docs/api.md similarity index 100% rename from src/ionic-angular-kit/docs/api.md rename to projects/docs/src/ionic-angular-kit/docs/api.md diff --git a/src/ionic-angular-kit/docs/auth-http.md b/projects/docs/src/ionic-angular-kit/docs/auth-http.md similarity index 100% rename from src/ionic-angular-kit/docs/auth-http.md rename to projects/docs/src/ionic-angular-kit/docs/auth-http.md diff --git a/src/ionic-angular-kit/docs/getting-started.md b/projects/docs/src/ionic-angular-kit/docs/getting-started.md similarity index 100% rename from src/ionic-angular-kit/docs/getting-started.md rename to projects/docs/src/ionic-angular-kit/docs/getting-started.md diff --git a/src/ionic-angular-kit/docs/ja/api.md b/projects/docs/src/ionic-angular-kit/docs/ja/api.md similarity index 100% rename from src/ionic-angular-kit/docs/ja/api.md rename to projects/docs/src/ionic-angular-kit/docs/ja/api.md diff --git a/src/ionic-angular-kit/docs/ja/auth-http.md b/projects/docs/src/ionic-angular-kit/docs/ja/auth-http.md similarity index 100% rename from src/ionic-angular-kit/docs/ja/auth-http.md rename to projects/docs/src/ionic-angular-kit/docs/ja/auth-http.md diff --git a/src/ionic-angular-kit/docs/ja/getting-started.md b/projects/docs/src/ionic-angular-kit/docs/ja/getting-started.md similarity index 100% rename from src/ionic-angular-kit/docs/ja/getting-started.md rename to projects/docs/src/ionic-angular-kit/docs/ja/getting-started.md diff --git a/src/ionic-angular-kit/docs/ja/offline-realtime.md b/projects/docs/src/ionic-angular-kit/docs/ja/offline-realtime.md similarity index 100% rename from src/ionic-angular-kit/docs/ja/offline-realtime.md rename to projects/docs/src/ionic-angular-kit/docs/ja/offline-realtime.md diff --git a/src/ionic-angular-kit/docs/ja/optional-features.md b/projects/docs/src/ionic-angular-kit/docs/ja/optional-features.md similarity index 100% rename from src/ionic-angular-kit/docs/ja/optional-features.md rename to projects/docs/src/ionic-angular-kit/docs/ja/optional-features.md diff --git a/src/ionic-angular-kit/docs/ja/storage-overlays.md b/projects/docs/src/ionic-angular-kit/docs/ja/storage-overlays.md similarity index 100% rename from src/ionic-angular-kit/docs/ja/storage-overlays.md rename to projects/docs/src/ionic-angular-kit/docs/ja/storage-overlays.md diff --git a/src/ionic-angular-kit/docs/offline-realtime.md b/projects/docs/src/ionic-angular-kit/docs/offline-realtime.md similarity index 100% rename from src/ionic-angular-kit/docs/offline-realtime.md rename to projects/docs/src/ionic-angular-kit/docs/offline-realtime.md diff --git a/src/ionic-angular-kit/docs/optional-features.md b/projects/docs/src/ionic-angular-kit/docs/optional-features.md similarity index 100% rename from src/ionic-angular-kit/docs/optional-features.md rename to projects/docs/src/ionic-angular-kit/docs/optional-features.md diff --git a/src/ionic-angular-kit/docs/storage-overlays.md b/projects/docs/src/ionic-angular-kit/docs/storage-overlays.md similarity index 100% rename from src/ionic-angular-kit/docs/storage-overlays.md rename to projects/docs/src/ionic-angular-kit/docs/storage-overlays.md diff --git a/src/ionic-angular-photo-editor/docs/api.md b/projects/docs/src/ionic-angular-photo-editor/docs/api.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/api.md rename to projects/docs/src/ionic-angular-photo-editor/docs/api.md diff --git a/src/ionic-angular-photo-editor/docs/editor.md b/projects/docs/src/ionic-angular-photo-editor/docs/editor.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/editor.md rename to projects/docs/src/ionic-angular-photo-editor/docs/editor.md diff --git a/src/ionic-angular-photo-editor/docs/ja/api.md b/projects/docs/src/ionic-angular-photo-editor/docs/ja/api.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/ja/api.md rename to projects/docs/src/ionic-angular-photo-editor/docs/ja/api.md diff --git a/src/ionic-angular-photo-editor/docs/ja/editor.md b/projects/docs/src/ionic-angular-photo-editor/docs/ja/editor.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/ja/editor.md rename to projects/docs/src/ionic-angular-photo-editor/docs/ja/editor.md diff --git a/src/ionic-angular-photo-editor/docs/ja/photo-file.md b/projects/docs/src/ionic-angular-photo-editor/docs/ja/photo-file.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/ja/photo-file.md rename to projects/docs/src/ionic-angular-photo-editor/docs/ja/photo-file.md diff --git a/src/ionic-angular-photo-editor/docs/ja/readme.md b/projects/docs/src/ionic-angular-photo-editor/docs/ja/readme.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/ja/readme.md rename to projects/docs/src/ionic-angular-photo-editor/docs/ja/readme.md diff --git a/src/ionic-angular-photo-editor/docs/ja/theme.md b/projects/docs/src/ionic-angular-photo-editor/docs/ja/theme.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/ja/theme.md rename to projects/docs/src/ionic-angular-photo-editor/docs/ja/theme.md diff --git a/src/ionic-angular-photo-editor/docs/ja/viewer.md b/projects/docs/src/ionic-angular-photo-editor/docs/ja/viewer.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/ja/viewer.md rename to projects/docs/src/ionic-angular-photo-editor/docs/ja/viewer.md diff --git a/src/ionic-angular-photo-editor/docs/photo-file.md b/projects/docs/src/ionic-angular-photo-editor/docs/photo-file.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/photo-file.md rename to projects/docs/src/ionic-angular-photo-editor/docs/photo-file.md diff --git a/src/ionic-angular-photo-editor/docs/readme.md b/projects/docs/src/ionic-angular-photo-editor/docs/readme.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/readme.md rename to projects/docs/src/ionic-angular-photo-editor/docs/readme.md diff --git a/src/ionic-angular-photo-editor/docs/theme.md b/projects/docs/src/ionic-angular-photo-editor/docs/theme.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/theme.md rename to projects/docs/src/ionic-angular-photo-editor/docs/theme.md diff --git a/src/ionic-angular-photo-editor/docs/viewer.md b/projects/docs/src/ionic-angular-photo-editor/docs/viewer.md similarity index 100% rename from src/ionic-angular-photo-editor/docs/viewer.md rename to projects/docs/src/ionic-angular-photo-editor/docs/viewer.md diff --git a/src/ionic-angular-scroll-header/docs/api.md b/projects/docs/src/ionic-angular-scroll-header/docs/api.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/api.md rename to projects/docs/src/ionic-angular-scroll-header/docs/api.md diff --git a/src/ionic-angular-scroll-header/docs/ion-content.md b/projects/docs/src/ionic-angular-scroll-header/docs/ion-content.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/ion-content.md rename to projects/docs/src/ionic-angular-scroll-header/docs/ion-content.md diff --git a/src/ionic-angular-scroll-header/docs/ja/api.md b/projects/docs/src/ionic-angular-scroll-header/docs/ja/api.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/ja/api.md rename to projects/docs/src/ionic-angular-scroll-header/docs/ja/api.md diff --git a/src/ionic-angular-scroll-header/docs/ja/ion-content.md b/projects/docs/src/ionic-angular-scroll-header/docs/ja/ion-content.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/ja/ion-content.md rename to projects/docs/src/ionic-angular-scroll-header/docs/ja/ion-content.md diff --git a/src/ionic-angular-scroll-header/docs/ja/readme.md b/projects/docs/src/ionic-angular-scroll-header/docs/ja/readme.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/ja/readme.md rename to projects/docs/src/ionic-angular-scroll-header/docs/ja/readme.md diff --git a/src/ionic-angular-scroll-header/docs/ja/safe-area.md b/projects/docs/src/ionic-angular-scroll-header/docs/ja/safe-area.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/ja/safe-area.md rename to projects/docs/src/ionic-angular-scroll-header/docs/ja/safe-area.md diff --git a/src/ionic-angular-scroll-header/docs/ja/virtual-scroll.md b/projects/docs/src/ionic-angular-scroll-header/docs/ja/virtual-scroll.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/ja/virtual-scroll.md rename to projects/docs/src/ionic-angular-scroll-header/docs/ja/virtual-scroll.md diff --git a/src/ionic-angular-scroll-header/docs/readme.md b/projects/docs/src/ionic-angular-scroll-header/docs/readme.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/readme.md rename to projects/docs/src/ionic-angular-scroll-header/docs/readme.md diff --git a/src/ionic-angular-scroll-header/docs/safe-area.md b/projects/docs/src/ionic-angular-scroll-header/docs/safe-area.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/safe-area.md rename to projects/docs/src/ionic-angular-scroll-header/docs/safe-area.md diff --git a/src/ionic-angular-scroll-header/docs/virtual-scroll.md b/projects/docs/src/ionic-angular-scroll-header/docs/virtual-scroll.md similarity index 100% rename from src/ionic-angular-scroll-header/docs/virtual-scroll.md rename to projects/docs/src/ionic-angular-scroll-header/docs/virtual-scroll.md diff --git a/src/ionic-theme-ios26/docs/api.md b/projects/docs/src/ionic-theme-ios26/docs/api.md similarity index 100% rename from src/ionic-theme-ios26/docs/api.md rename to projects/docs/src/ionic-theme-ios26/docs/api.md diff --git a/src/ionic-theme-ios26/docs/experimental-animation.md b/projects/docs/src/ionic-theme-ios26/docs/experimental-animation.md similarity index 100% rename from src/ionic-theme-ios26/docs/experimental-animation.md rename to projects/docs/src/ionic-theme-ios26/docs/experimental-animation.md diff --git a/src/ionic-theme-ios26/docs/features.md b/projects/docs/src/ionic-theme-ios26/docs/features.md similarity index 100% rename from src/ionic-theme-ios26/docs/features.md rename to projects/docs/src/ionic-theme-ios26/docs/features.md diff --git a/src/ionic-theme-ios26/docs/ios-18.md b/projects/docs/src/ionic-theme-ios26/docs/ios-18.md similarity index 100% rename from src/ionic-theme-ios26/docs/ios-18.md rename to projects/docs/src/ionic-theme-ios26/docs/ios-18.md diff --git a/src/ionic-theme-ios26/docs/ja/api.md b/projects/docs/src/ionic-theme-ios26/docs/ja/api.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/api.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/api.md diff --git a/src/ionic-theme-ios26/docs/ja/experimental-animation.md b/projects/docs/src/ionic-theme-ios26/docs/ja/experimental-animation.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/experimental-animation.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/experimental-animation.md diff --git a/src/ionic-theme-ios26/docs/ja/features.md b/projects/docs/src/ionic-theme-ios26/docs/ja/features.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/features.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/features.md diff --git a/src/ionic-theme-ios26/docs/ja/ios-18.md b/projects/docs/src/ionic-theme-ios26/docs/ja/ios-18.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/ios-18.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/ios-18.md diff --git a/src/ionic-theme-ios26/docs/ja/migration.md b/projects/docs/src/ionic-theme-ios26/docs/ja/migration.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/migration.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/migration.md diff --git a/src/ionic-theme-ios26/docs/ja/readme.md b/projects/docs/src/ionic-theme-ios26/docs/ja/readme.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/readme.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/readme.md diff --git a/src/ionic-theme-ios26/docs/ja/special-markup.md b/projects/docs/src/ionic-theme-ios26/docs/ja/special-markup.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/special-markup.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/special-markup.md diff --git a/src/ionic-theme-ios26/docs/ja/using-ion-item-group.md b/projects/docs/src/ionic-theme-ios26/docs/ja/using-ion-item-group.md similarity index 100% rename from src/ionic-theme-ios26/docs/ja/using-ion-item-group.md rename to projects/docs/src/ionic-theme-ios26/docs/ja/using-ion-item-group.md diff --git a/src/ionic-theme-ios26/docs/migration.md b/projects/docs/src/ionic-theme-ios26/docs/migration.md similarity index 100% rename from src/ionic-theme-ios26/docs/migration.md rename to projects/docs/src/ionic-theme-ios26/docs/migration.md diff --git a/src/ionic-theme-ios26/docs/readme.md b/projects/docs/src/ionic-theme-ios26/docs/readme.md similarity index 100% rename from src/ionic-theme-ios26/docs/readme.md rename to projects/docs/src/ionic-theme-ios26/docs/readme.md diff --git a/src/ionic-theme-ios26/docs/using-ion-item-group.md b/projects/docs/src/ionic-theme-ios26/docs/using-ion-item-group.md similarity index 100% rename from src/ionic-theme-ios26/docs/using-ion-item-group.md rename to projects/docs/src/ionic-theme-ios26/docs/using-ion-item-group.md diff --git a/src/ionic-theme-md3/docs/api.md b/projects/docs/src/ionic-theme-md3/docs/api.md similarity index 100% rename from src/ionic-theme-md3/docs/api.md rename to projects/docs/src/ionic-theme-md3/docs/api.md diff --git a/src/ionic-theme-md3/docs/ja/api.md b/projects/docs/src/ionic-theme-md3/docs/ja/api.md similarity index 100% rename from src/ionic-theme-md3/docs/ja/api.md rename to projects/docs/src/ionic-theme-md3/docs/ja/api.md diff --git a/src/ionic-theme-md3/docs/ja/migration.md b/projects/docs/src/ionic-theme-md3/docs/ja/migration.md similarity index 100% rename from src/ionic-theme-md3/docs/ja/migration.md rename to projects/docs/src/ionic-theme-md3/docs/ja/migration.md diff --git a/src/ionic-theme-md3/docs/ja/readme.md b/projects/docs/src/ionic-theme-md3/docs/ja/readme.md similarity index 100% rename from src/ionic-theme-md3/docs/ja/readme.md rename to projects/docs/src/ionic-theme-md3/docs/ja/readme.md diff --git a/src/ionic-theme-md3/docs/ja/special-markup.md b/projects/docs/src/ionic-theme-md3/docs/ja/special-markup.md similarity index 100% rename from src/ionic-theme-md3/docs/ja/special-markup.md rename to projects/docs/src/ionic-theme-md3/docs/ja/special-markup.md diff --git a/src/ionic-theme-md3/docs/ja/using-ion-item-group.md b/projects/docs/src/ionic-theme-md3/docs/ja/using-ion-item-group.md similarity index 100% rename from src/ionic-theme-md3/docs/ja/using-ion-item-group.md rename to projects/docs/src/ionic-theme-md3/docs/ja/using-ion-item-group.md diff --git a/src/ionic-theme-md3/docs/readme.md b/projects/docs/src/ionic-theme-md3/docs/readme.md similarity index 100% rename from src/ionic-theme-md3/docs/readme.md rename to projects/docs/src/ionic-theme-md3/docs/readme.md diff --git a/src/locale/messages.en.xlf b/projects/docs/src/locale/messages.en.xlf similarity index 66% rename from src/locale/messages.en.xlf rename to projects/docs/src/locale/messages.en.xlf index e66de77..2b1ddb5 100644 --- a/src/locale/messages.en.xlf +++ b/projects/docs/src/locale/messages.en.xlf @@ -3,7 +3,7 @@ - src/app/app.html:5,8 + projects/docs/src/app/app.html:5,8 Skip to content @@ -11,7 +11,7 @@ - src/app/app.html:19,21 + projects/docs/src/app/app.html:19,21 Toggle documentation menu @@ -19,7 +19,7 @@ - src/app/app.html:48,50 + projects/docs/src/app/app.html:48,50 Switch language @@ -27,7 +27,7 @@ - src/app/app.html:62,65 + projects/docs/src/app/app.html:62,65 View on GitHub @@ -35,7 +35,7 @@ - src/app/app.html:77,79 + projects/docs/src/app/app.html:77,79 Close documentation menu @@ -43,7 +43,7 @@ - src/app/app.html:90,92 + projects/docs/src/app/app.html:90,92 Documentation @@ -51,7 +51,7 @@ - src/app/app.html:92,94 + projects/docs/src/app/app.html:92,94 Projects @@ -59,7 +59,7 @@ - src/app/app.html:106,110 + projects/docs/src/app/app.html:106,110 All projects @@ -67,7 +67,7 @@ - src/app/app.html:123,126 + projects/docs/src/app/app.html:123,126 Support @@ -75,7 +75,7 @@ - src/app/app.html:179,180 + projects/docs/src/app/app.html:179,180 Overview @@ -83,7 +83,7 @@ - src/app/app.html:215,218 + projects/docs/src/app/app.html:215,218 Personal open source projects maintained by rdlabo. @@ -91,7 +91,7 @@ - src/app/app.html:224,226 + projects/docs/src/app/app.html:224,226 Support these projects @@ -99,7 +99,7 @@ - src/app/app.html:227,230 + projects/docs/src/app/app.html:227,230 © 2026 rdlabo. Released under the MIT License. @@ -107,7 +107,7 @@ - src/app/docs/docs-page.ts:74,77 + projects/docs/src/app/docs/docs-page.ts:74,77 Table of contents @@ -115,7 +115,7 @@ - src/app/docs/docs-page.ts:79,80 + projects/docs/src/app/docs/docs-page.ts:79,80 Contents @@ -123,7 +123,7 @@ - src/app/docs/docs-page.ts:81,82 + projects/docs/src/app/docs/docs-page.ts:81,82 On this page @@ -131,7 +131,7 @@ - src/app/docs/docs-page.ts:107,108 + projects/docs/src/app/docs/docs-page.ts:107,108 Edit this page on GitHub @@ -139,7 +139,7 @@ - src/app/docs/landing-page.ts:48,49 + projects/docs/src/app/docs/landing-page.ts:48,49 Get started @@ -147,7 +147,7 @@ - src/app/docs/landing-page.ts:56,57 + projects/docs/src/app/docs/landing-page.ts:56,57 View source @@ -155,7 +155,7 @@ - src/app/docs/landing-page.ts:73,74 + projects/docs/src/app/docs/landing-page.ts:73,74 Star on GitHub @@ -163,7 +163,7 @@ - src/app/docs/not-found.ts:11,13 + projects/docs/src/app/docs/not-found.ts:11,13 Page not found @@ -171,8 +171,8 @@ - src/app/docs/not-found.ts:15,17 - src/app/docs/not-found.ts:34 + projects/docs/src/app/docs/not-found.ts:15,17 + projects/docs/src/app/docs/not-found.ts:34 The page may have moved while the documentation was being reorganized. @@ -180,7 +180,7 @@ - src/app/docs/not-found.ts:22,24 + projects/docs/src/app/docs/not-found.ts:22,24 Browse projects @@ -188,7 +188,7 @@ - src/app/docs/not-found.ts:33 + projects/docs/src/app/docs/not-found.ts:33 Page not found - rdlabo.dev @@ -196,7 +196,7 @@ - src/app/docs/plugin-index.ts:17,19 + projects/docs/src/app/docs/plugin-index.ts:17,19 Open source documentation @@ -204,7 +204,7 @@ - src/app/docs/plugin-index.ts:26,27 + projects/docs/src/app/docs/plugin-index.ts:26,27 Documentation for open source projects created and maintained by rdlabo. @@ -212,7 +212,7 @@ - src/app/docs/plugin-index.ts:34,36 + projects/docs/src/app/docs/plugin-index.ts:34,36 Every OSS project listed here is developed and maintained personally by rdlabo. They are independent of the incorporated association that also uses the rdlabo name. @@ -220,7 +220,7 @@ - src/app/docs/plugin-index.ts:50,52 + projects/docs/src/app/docs/plugin-index.ts:50,52 Current collection @@ -228,7 +228,7 @@ - src/app/docs/plugin-index.ts:81,82 + projects/docs/src/app/docs/plugin-index.ts:81,82 Read documentation @@ -236,7 +236,7 @@ - src/app/docs/plugin-index.ts:95,97 + projects/docs/src/app/docs/plugin-index.ts:95,97 Growing collection @@ -244,7 +244,7 @@ - src/app/docs/plugin-index.ts:99,101 + projects/docs/src/app/docs/plugin-index.ts:99,101 More rdlabo projects will be documented here as they are released. @@ -252,7 +252,7 @@ - src/app/docs/plugin-index.ts:122 + projects/docs/src/app/docs/plugin-index.ts:122 Documentation for personal open source projects created and maintained by rdlabo. @@ -260,7 +260,7 @@ - src/app/docs/support-page.ts:9,11 + projects/docs/src/app/docs/support-page.ts:9,11 Support open source @@ -268,7 +268,7 @@ - src/app/docs/support-page.ts:14,16 + projects/docs/src/app/docs/support-page.ts:14,16 Help rdlabo projects keep moving @@ -276,7 +276,7 @@ - src/app/docs/support-page.ts:18,20 + projects/docs/src/app/docs/support-page.ts:18,20 The projects documented here are maintained personally by rdlabo. Sponsorship supports the collection as a whole, rather than one individual library. @@ -284,7 +284,7 @@ - src/app/docs/support-page.ts:30,32 + projects/docs/src/app/docs/support-page.ts:30,32 Current sponsors @@ -292,7 +292,7 @@ - src/app/docs/support-page.ts:34,36 + projects/docs/src/app/docs/support-page.ts:34,36 Thank you to the people and organizations supporting rdlabo's open source work. @@ -300,7 +300,7 @@ - src/app/docs/support-page.ts + projects/docs/src/app/docs/support-page.ts Past sponsors @@ -308,7 +308,7 @@ - src/app/docs/support-page.ts + projects/docs/src/app/docs/support-page.ts Thank you also to everyone who has supported this work in the past. @@ -316,7 +316,7 @@ - src/app/docs/support-page.ts:28,30 + projects/docs/src/app/docs/support-page.ts:28,30 Sponsor on GitHub @@ -324,7 +324,7 @@ - src/app/docs/support-page.ts:32,34 + projects/docs/src/app/docs/support-page.ts:32,34 Your support helps fund maintenance, compatibility updates, documentation, and new features across rdlabo's open source projects. @@ -332,7 +332,7 @@ - src/app/docs/support-page.ts:44,45 + projects/docs/src/app/docs/support-page.ts:44,45 Become a sponsor @@ -340,7 +340,7 @@ - src/app/docs/support-page.ts:52,55 + projects/docs/src/app/docs/support-page.ts:52,55 Sponsorship supports open source work maintained personally by rdlabo. @@ -348,7 +348,7 @@ - src/app/docs/support-page.ts:64 + projects/docs/src/app/docs/support-page.ts:64 Support open source - rdlabo.dev @@ -356,7 +356,7 @@ - src/app/docs/support-page.ts:65 + projects/docs/src/app/docs/support-page.ts:65 Support maintenance, documentation, and development across rdlabo's open source projects. diff --git a/src/locale/messages.ja.xlf b/projects/docs/src/locale/messages.ja.xlf similarity index 100% rename from src/locale/messages.ja.xlf rename to projects/docs/src/locale/messages.ja.xlf diff --git a/src/main.server.ts b/projects/docs/src/main.server.ts similarity index 100% rename from src/main.server.ts rename to projects/docs/src/main.server.ts diff --git a/src/main.ts b/projects/docs/src/main.ts similarity index 100% rename from src/main.ts rename to projects/docs/src/main.ts diff --git a/src/ngx-cdk-scroll-strategies/docs/advanced.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/advanced.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/advanced.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/advanced.md diff --git a/src/ngx-cdk-scroll-strategies/docs/api.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/api.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/api.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/api.md diff --git a/src/ngx-cdk-scroll-strategies/docs/faq.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/faq.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/faq.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/faq.md diff --git a/src/ngx-cdk-scroll-strategies/docs/ja/advanced.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/advanced.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/ja/advanced.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/advanced.md diff --git a/src/ngx-cdk-scroll-strategies/docs/ja/api.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/api.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/ja/api.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/api.md diff --git a/src/ngx-cdk-scroll-strategies/docs/ja/faq.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/faq.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/ja/faq.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/faq.md diff --git a/src/ngx-cdk-scroll-strategies/docs/ja/readme.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/readme.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/ja/readme.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/readme.md diff --git a/src/ngx-cdk-scroll-strategies/docs/ja/reverse.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/reverse.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/ja/reverse.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/reverse.md diff --git a/src/ngx-cdk-scroll-strategies/docs/ja/simple.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/simple.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/ja/simple.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/ja/simple.md diff --git a/src/ngx-cdk-scroll-strategies/docs/readme.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/readme.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/readme.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/readme.md diff --git a/src/ngx-cdk-scroll-strategies/docs/reverse.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/reverse.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/reverse.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/reverse.md diff --git a/src/ngx-cdk-scroll-strategies/docs/simple.md b/projects/docs/src/ngx-cdk-scroll-strategies/docs/simple.md similarity index 100% rename from src/ngx-cdk-scroll-strategies/docs/simple.md rename to projects/docs/src/ngx-cdk-scroll-strategies/docs/simple.md diff --git a/src/server.ts b/projects/docs/src/server.ts similarity index 100% rename from src/server.ts rename to projects/docs/src/server.ts diff --git a/src/stripe-identity/config/docs.json b/projects/docs/src/stripe-identity/config/docs.json similarity index 100% rename from src/stripe-identity/config/docs.json rename to projects/docs/src/stripe-identity/config/docs.json diff --git a/src/stripe-identity/config/packages.json b/projects/docs/src/stripe-identity/config/packages.json similarity index 100% rename from src/stripe-identity/config/packages.json rename to projects/docs/src/stripe-identity/config/packages.json diff --git a/src/stripe-identity/docs/api.md b/projects/docs/src/stripe-identity/docs/api.md similarity index 100% rename from src/stripe-identity/docs/api.md rename to projects/docs/src/stripe-identity/docs/api.md diff --git a/src/stripe-identity/docs/configuration.md b/projects/docs/src/stripe-identity/docs/configuration.md similarity index 100% rename from src/stripe-identity/docs/configuration.md rename to projects/docs/src/stripe-identity/docs/configuration.md diff --git a/src/stripe-identity/docs/identity-verification-sheet.md b/projects/docs/src/stripe-identity/docs/identity-verification-sheet.md similarity index 100% rename from src/stripe-identity/docs/identity-verification-sheet.md rename to projects/docs/src/stripe-identity/docs/identity-verification-sheet.md diff --git a/src/stripe-identity/docs/identity-verification-sheet/example.ts.md b/projects/docs/src/stripe-identity/docs/identity-verification-sheet/example.ts.md similarity index 100% rename from src/stripe-identity/docs/identity-verification-sheet/example.ts.md rename to projects/docs/src/stripe-identity/docs/identity-verification-sheet/example.ts.md diff --git a/src/stripe-identity/docs/ja/api.md b/projects/docs/src/stripe-identity/docs/ja/api.md similarity index 100% rename from src/stripe-identity/docs/ja/api.md rename to projects/docs/src/stripe-identity/docs/ja/api.md diff --git a/src/stripe-identity/docs/ja/configuration.md b/projects/docs/src/stripe-identity/docs/ja/configuration.md similarity index 100% rename from src/stripe-identity/docs/ja/configuration.md rename to projects/docs/src/stripe-identity/docs/ja/configuration.md diff --git a/src/stripe-identity/docs/ja/identity-verification-sheet.md b/projects/docs/src/stripe-identity/docs/ja/identity-verification-sheet.md similarity index 100% rename from src/stripe-identity/docs/ja/identity-verification-sheet.md rename to projects/docs/src/stripe-identity/docs/ja/identity-verification-sheet.md diff --git a/src/stripe-terminal/config/docs.json b/projects/docs/src/stripe-terminal/config/docs.json similarity index 100% rename from src/stripe-terminal/config/docs.json rename to projects/docs/src/stripe-terminal/config/docs.json diff --git a/src/stripe-terminal/config/packages.json b/projects/docs/src/stripe-terminal/config/packages.json similarity index 100% rename from src/stripe-terminal/config/packages.json rename to projects/docs/src/stripe-terminal/config/packages.json diff --git a/src/stripe-terminal/docs/api.md b/projects/docs/src/stripe-terminal/docs/api.md similarity index 100% rename from src/stripe-terminal/docs/api.md rename to projects/docs/src/stripe-terminal/docs/api.md diff --git a/src/stripe-terminal/docs/collect-a-payment.md b/projects/docs/src/stripe-terminal/docs/collect-a-payment.md similarity index 100% rename from src/stripe-terminal/docs/collect-a-payment.md rename to projects/docs/src/stripe-terminal/docs/collect-a-payment.md diff --git a/src/stripe-terminal/docs/collect-a-payment/collect-payment.ts.md b/projects/docs/src/stripe-terminal/docs/collect-a-payment/collect-payment.ts.md similarity index 100% rename from src/stripe-terminal/docs/collect-a-payment/collect-payment.ts.md rename to projects/docs/src/stripe-terminal/docs/collect-a-payment/collect-payment.ts.md diff --git a/src/stripe-terminal/docs/collect-a-payment/connection-token.ts.md b/projects/docs/src/stripe-terminal/docs/collect-a-payment/connection-token.ts.md similarity index 100% rename from src/stripe-terminal/docs/collect-a-payment/connection-token.ts.md rename to projects/docs/src/stripe-terminal/docs/collect-a-payment/connection-token.ts.md diff --git a/src/stripe-terminal/docs/configuration.md b/projects/docs/src/stripe-terminal/docs/configuration.md similarity index 100% rename from src/stripe-terminal/docs/configuration.md rename to projects/docs/src/stripe-terminal/docs/configuration.md diff --git a/src/stripe-terminal/docs/ja/api.md b/projects/docs/src/stripe-terminal/docs/ja/api.md similarity index 100% rename from src/stripe-terminal/docs/ja/api.md rename to projects/docs/src/stripe-terminal/docs/ja/api.md diff --git a/src/stripe-terminal/docs/ja/collect-a-payment.md b/projects/docs/src/stripe-terminal/docs/ja/collect-a-payment.md similarity index 100% rename from src/stripe-terminal/docs/ja/collect-a-payment.md rename to projects/docs/src/stripe-terminal/docs/ja/collect-a-payment.md diff --git a/src/stripe-terminal/docs/ja/configuration.md b/projects/docs/src/stripe-terminal/docs/ja/configuration.md similarity index 100% rename from src/stripe-terminal/docs/ja/configuration.md rename to projects/docs/src/stripe-terminal/docs/ja/configuration.md diff --git a/src/stripe-terminal/docs/ja/reader-lifecycle.md b/projects/docs/src/stripe-terminal/docs/ja/reader-lifecycle.md similarity index 100% rename from src/stripe-terminal/docs/ja/reader-lifecycle.md rename to projects/docs/src/stripe-terminal/docs/ja/reader-lifecycle.md diff --git a/src/stripe-terminal/docs/ja/tap-to-pay.md b/projects/docs/src/stripe-terminal/docs/ja/tap-to-pay.md similarity index 100% rename from src/stripe-terminal/docs/ja/tap-to-pay.md rename to projects/docs/src/stripe-terminal/docs/ja/tap-to-pay.md diff --git a/src/stripe-terminal/docs/reader-lifecycle.md b/projects/docs/src/stripe-terminal/docs/reader-lifecycle.md similarity index 100% rename from src/stripe-terminal/docs/reader-lifecycle.md rename to projects/docs/src/stripe-terminal/docs/reader-lifecycle.md diff --git a/src/stripe-terminal/docs/reader-lifecycle/reader-lifecycle.ts.md b/projects/docs/src/stripe-terminal/docs/reader-lifecycle/reader-lifecycle.ts.md similarity index 100% rename from src/stripe-terminal/docs/reader-lifecycle/reader-lifecycle.ts.md rename to projects/docs/src/stripe-terminal/docs/reader-lifecycle/reader-lifecycle.ts.md diff --git a/src/stripe-terminal/docs/tap-to-pay.md b/projects/docs/src/stripe-terminal/docs/tap-to-pay.md similarity index 100% rename from src/stripe-terminal/docs/tap-to-pay.md rename to projects/docs/src/stripe-terminal/docs/tap-to-pay.md diff --git a/src/stripe-terminal/docs/tap-to-pay/tap-to-pay.ts.md b/projects/docs/src/stripe-terminal/docs/tap-to-pay/tap-to-pay.ts.md similarity index 100% rename from src/stripe-terminal/docs/tap-to-pay/tap-to-pay.ts.md rename to projects/docs/src/stripe-terminal/docs/tap-to-pay/tap-to-pay.ts.md diff --git a/src/stripe/assets/capacitor-image.png b/projects/docs/src/stripe/assets/capacitor-image.png similarity index 100% rename from src/stripe/assets/capacitor-image.png rename to projects/docs/src/stripe/assets/capacitor-image.png diff --git a/src/stripe/assets/doctr.svg b/projects/docs/src/stripe/assets/doctr.svg similarity index 100% rename from src/stripe/assets/doctr.svg rename to projects/docs/src/stripe/assets/doctr.svg diff --git a/src/stripe/assets/sunset.png b/projects/docs/src/stripe/assets/sunset.png similarity index 100% rename from src/stripe/assets/sunset.png rename to projects/docs/src/stripe/assets/sunset.png diff --git a/src/stripe/assets/vegasbuilt.svg b/projects/docs/src/stripe/assets/vegasbuilt.svg similarity index 100% rename from src/stripe/assets/vegasbuilt.svg rename to projects/docs/src/stripe/assets/vegasbuilt.svg diff --git a/src/stripe/config/docs.json b/projects/docs/src/stripe/config/docs.json similarity index 100% rename from src/stripe/config/docs.json rename to projects/docs/src/stripe/config/docs.json diff --git a/src/stripe/config/packages.json b/projects/docs/src/stripe/config/packages.json similarity index 100% rename from src/stripe/config/packages.json rename to projects/docs/src/stripe/config/packages.json diff --git a/src/stripe/docs/angular.md b/projects/docs/src/stripe/docs/angular.md similarity index 100% rename from src/stripe/docs/angular.md rename to projects/docs/src/stripe/docs/angular.md diff --git a/src/stripe/docs/api.md b/projects/docs/src/stripe/docs/api.md similarity index 100% rename from src/stripe/docs/api.md rename to projects/docs/src/stripe/docs/api.md diff --git a/src/stripe/docs/apple-pay.md b/projects/docs/src/stripe/docs/apple-pay.md similarity index 100% rename from src/stripe/docs/apple-pay.md rename to projects/docs/src/stripe/docs/apple-pay.md diff --git a/src/stripe/docs/apple-pay/apple-pay.ts.md b/projects/docs/src/stripe/docs/apple-pay/apple-pay.ts.md similarity index 100% rename from src/stripe/docs/apple-pay/apple-pay.ts.md rename to projects/docs/src/stripe/docs/apple-pay/apple-pay.ts.md diff --git a/src/stripe/docs/configuration.md b/projects/docs/src/stripe/docs/configuration.md similarity index 100% rename from src/stripe/docs/configuration.md rename to projects/docs/src/stripe/docs/configuration.md diff --git a/src/stripe/docs/google-pay.md b/projects/docs/src/stripe/docs/google-pay.md similarity index 100% rename from src/stripe/docs/google-pay.md rename to projects/docs/src/stripe/docs/google-pay.md diff --git a/src/stripe/docs/google-pay/android-manifest.xml.md b/projects/docs/src/stripe/docs/google-pay/android-manifest.xml.md similarity index 100% rename from src/stripe/docs/google-pay/android-manifest.xml.md rename to projects/docs/src/stripe/docs/google-pay/android-manifest.xml.md diff --git a/src/stripe/docs/google-pay/google-pay.ts.md b/projects/docs/src/stripe/docs/google-pay/google-pay.ts.md similarity index 100% rename from src/stripe/docs/google-pay/google-pay.ts.md rename to projects/docs/src/stripe/docs/google-pay/google-pay.ts.md diff --git a/src/stripe/docs/google-pay/strings.xml.md b/projects/docs/src/stripe/docs/google-pay/strings.xml.md similarity index 100% rename from src/stripe/docs/google-pay/strings.xml.md rename to projects/docs/src/stripe/docs/google-pay/strings.xml.md diff --git a/src/stripe/docs/initialize.md b/projects/docs/src/stripe/docs/initialize.md similarity index 100% rename from src/stripe/docs/initialize.md rename to projects/docs/src/stripe/docs/initialize.md diff --git a/src/stripe/docs/ja/angular.md b/projects/docs/src/stripe/docs/ja/angular.md similarity index 100% rename from src/stripe/docs/ja/angular.md rename to projects/docs/src/stripe/docs/ja/angular.md diff --git a/src/stripe/docs/ja/api.md b/projects/docs/src/stripe/docs/ja/api.md similarity index 100% rename from src/stripe/docs/ja/api.md rename to projects/docs/src/stripe/docs/ja/api.md diff --git a/src/stripe/docs/ja/apple-pay.md b/projects/docs/src/stripe/docs/ja/apple-pay.md similarity index 100% rename from src/stripe/docs/ja/apple-pay.md rename to projects/docs/src/stripe/docs/ja/apple-pay.md diff --git a/src/stripe/docs/ja/configuration.md b/projects/docs/src/stripe/docs/ja/configuration.md similarity index 100% rename from src/stripe/docs/ja/configuration.md rename to projects/docs/src/stripe/docs/ja/configuration.md diff --git a/src/stripe/docs/ja/google-pay.md b/projects/docs/src/stripe/docs/ja/google-pay.md similarity index 100% rename from src/stripe/docs/ja/google-pay.md rename to projects/docs/src/stripe/docs/ja/google-pay.md diff --git a/src/stripe/docs/ja/initialize.md b/projects/docs/src/stripe/docs/ja/initialize.md similarity index 100% rename from src/stripe/docs/ja/initialize.md rename to projects/docs/src/stripe/docs/ja/initialize.md diff --git a/src/stripe/docs/ja/learn/event-listeners.md b/projects/docs/src/stripe/docs/ja/learn/event-listeners.md similarity index 100% rename from src/stripe/docs/ja/learn/event-listeners.md rename to projects/docs/src/stripe/docs/ja/learn/event-listeners.md diff --git a/src/stripe/docs/ja/payment-flow.md b/projects/docs/src/stripe/docs/ja/payment-flow.md similarity index 100% rename from src/stripe/docs/ja/payment-flow.md rename to projects/docs/src/stripe/docs/ja/payment-flow.md diff --git a/src/stripe/docs/ja/payment-sheet.md b/projects/docs/src/stripe/docs/ja/payment-sheet.md similarity index 100% rename from src/stripe/docs/ja/payment-sheet.md rename to projects/docs/src/stripe/docs/ja/payment-sheet.md diff --git a/src/stripe/docs/ja/react.md b/projects/docs/src/stripe/docs/ja/react.md similarity index 100% rename from src/stripe/docs/ja/react.md rename to projects/docs/src/stripe/docs/ja/react.md diff --git a/src/stripe/docs/ja/server-integration.md b/projects/docs/src/stripe/docs/ja/server-integration.md similarity index 100% rename from src/stripe/docs/ja/server-integration.md rename to projects/docs/src/stripe/docs/ja/server-integration.md diff --git a/src/stripe/docs/ja/vanilla-js.md b/projects/docs/src/stripe/docs/ja/vanilla-js.md similarity index 100% rename from src/stripe/docs/ja/vanilla-js.md rename to projects/docs/src/stripe/docs/ja/vanilla-js.md diff --git a/src/stripe/docs/learn/event-listeners.md b/projects/docs/src/stripe/docs/learn/event-listeners.md similarity index 100% rename from src/stripe/docs/learn/event-listeners.md rename to projects/docs/src/stripe/docs/learn/event-listeners.md diff --git a/src/stripe/docs/payment-flow.md b/projects/docs/src/stripe/docs/payment-flow.md similarity index 100% rename from src/stripe/docs/payment-flow.md rename to projects/docs/src/stripe/docs/payment-flow.md diff --git a/src/stripe/docs/payment-flow/payment-flow.ts.md b/projects/docs/src/stripe/docs/payment-flow/payment-flow.ts.md similarity index 100% rename from src/stripe/docs/payment-flow/payment-flow.ts.md rename to projects/docs/src/stripe/docs/payment-flow/payment-flow.ts.md diff --git a/src/stripe/docs/payment-sheet.md b/projects/docs/src/stripe/docs/payment-sheet.md similarity index 100% rename from src/stripe/docs/payment-sheet.md rename to projects/docs/src/stripe/docs/payment-sheet.md diff --git a/src/stripe/docs/payment-sheet/payment-sheet.ts.md b/projects/docs/src/stripe/docs/payment-sheet/payment-sheet.ts.md similarity index 100% rename from src/stripe/docs/payment-sheet/payment-sheet.ts.md rename to projects/docs/src/stripe/docs/payment-sheet/payment-sheet.ts.md diff --git a/src/stripe/docs/react.md b/projects/docs/src/stripe/docs/react.md similarity index 100% rename from src/stripe/docs/react.md rename to projects/docs/src/stripe/docs/react.md diff --git a/src/stripe/docs/server-integration.md b/projects/docs/src/stripe/docs/server-integration.md similarity index 100% rename from src/stripe/docs/server-integration.md rename to projects/docs/src/stripe/docs/server-integration.md diff --git a/src/stripe/docs/vanilla-js.md b/projects/docs/src/stripe/docs/vanilla-js.md similarity index 100% rename from src/stripe/docs/vanilla-js.md rename to projects/docs/src/stripe/docs/vanilla-js.md diff --git a/src/styles.css b/projects/docs/src/styles.css similarity index 100% rename from src/styles.css rename to projects/docs/src/styles.css diff --git a/src/workers-hono-kit/docs/api.md b/projects/docs/src/workers-hono-kit/docs/api.md similarity index 100% rename from src/workers-hono-kit/docs/api.md rename to projects/docs/src/workers-hono-kit/docs/api.md diff --git a/src/workers-hono-kit/docs/data-layer.md b/projects/docs/src/workers-hono-kit/docs/data-layer.md similarity index 100% rename from src/workers-hono-kit/docs/data-layer.md rename to projects/docs/src/workers-hono-kit/docs/data-layer.md diff --git a/src/workers-hono-kit/docs/getting-started.md b/projects/docs/src/workers-hono-kit/docs/getting-started.md similarity index 100% rename from src/workers-hono-kit/docs/getting-started.md rename to projects/docs/src/workers-hono-kit/docs/getting-started.md diff --git a/src/workers-hono-kit/docs/http-auth.md b/projects/docs/src/workers-hono-kit/docs/http-auth.md similarity index 100% rename from src/workers-hono-kit/docs/http-auth.md rename to projects/docs/src/workers-hono-kit/docs/http-auth.md diff --git a/src/workers-hono-kit/docs/ja/api.md b/projects/docs/src/workers-hono-kit/docs/ja/api.md similarity index 100% rename from src/workers-hono-kit/docs/ja/api.md rename to projects/docs/src/workers-hono-kit/docs/ja/api.md diff --git a/src/workers-hono-kit/docs/ja/data-layer.md b/projects/docs/src/workers-hono-kit/docs/ja/data-layer.md similarity index 100% rename from src/workers-hono-kit/docs/ja/data-layer.md rename to projects/docs/src/workers-hono-kit/docs/ja/data-layer.md diff --git a/src/workers-hono-kit/docs/ja/getting-started.md b/projects/docs/src/workers-hono-kit/docs/ja/getting-started.md similarity index 100% rename from src/workers-hono-kit/docs/ja/getting-started.md rename to projects/docs/src/workers-hono-kit/docs/ja/getting-started.md diff --git a/src/workers-hono-kit/docs/ja/http-auth.md b/projects/docs/src/workers-hono-kit/docs/ja/http-auth.md similarity index 100% rename from src/workers-hono-kit/docs/ja/http-auth.md rename to projects/docs/src/workers-hono-kit/docs/ja/http-auth.md diff --git a/src/workers-hono-kit/docs/ja/realtime-offline.md b/projects/docs/src/workers-hono-kit/docs/ja/realtime-offline.md similarity index 100% rename from src/workers-hono-kit/docs/ja/realtime-offline.md rename to projects/docs/src/workers-hono-kit/docs/ja/realtime-offline.md diff --git a/src/workers-hono-kit/docs/ja/testing-operations.md b/projects/docs/src/workers-hono-kit/docs/ja/testing-operations.md similarity index 100% rename from src/workers-hono-kit/docs/ja/testing-operations.md rename to projects/docs/src/workers-hono-kit/docs/ja/testing-operations.md diff --git a/src/workers-hono-kit/docs/realtime-offline.md b/projects/docs/src/workers-hono-kit/docs/realtime-offline.md similarity index 100% rename from src/workers-hono-kit/docs/realtime-offline.md rename to projects/docs/src/workers-hono-kit/docs/realtime-offline.md diff --git a/src/workers-hono-kit/docs/testing-operations.md b/projects/docs/src/workers-hono-kit/docs/testing-operations.md similarity index 100% rename from src/workers-hono-kit/docs/testing-operations.md rename to projects/docs/src/workers-hono-kit/docs/testing-operations.md diff --git a/tsconfig.app.json b/projects/docs/tsconfig.app.json similarity index 79% rename from tsconfig.app.json rename to projects/docs/tsconfig.app.json index fbffad3..89283b7 100644 --- a/tsconfig.app.json +++ b/projects/docs/tsconfig.app.json @@ -1,5 +1,5 @@ { - "extends": "./tsconfig.json", + "extends": "../../tsconfig.json", "compilerOptions": { "types": ["node", "@angular/localize"] }, diff --git a/tsconfig.spec.json b/projects/docs/tsconfig.spec.json similarity index 79% rename from tsconfig.spec.json rename to projects/docs/tsconfig.spec.json index bfdba35..7762cb0 100644 --- a/tsconfig.spec.json +++ b/projects/docs/tsconfig.spec.json @@ -1,5 +1,5 @@ { - "extends": "./tsconfig.json", + "extends": "../../tsconfig.json", "compilerOptions": { "types": ["vitest/globals", "@angular/localize"] }, diff --git a/scripts/bilingual-update-blocker.test.ts b/scripts/bilingual-update-blocker.test.ts index 7a4d918..b62ac11 100644 --- a/scripts/bilingual-update-blocker.test.ts +++ b/scripts/bilingual-update-blocker.test.ts @@ -56,8 +56,8 @@ test('block EN doc updates without corresponding JA updates', async () => { const enToJa = new Map(); for (const project of projectDefinitions) { for (const page of project.pages) { - const enPath = `src/${project.sourceDirectory}/docs/${page.file}`; - const jaPath = `src/${project.sourceDirectory}/docs/ja/${page.file}`; + const enPath = `projects/docs/src/${project.sourceDirectory}/docs/${page.file}`; + const jaPath = `projects/docs/src/${project.sourceDirectory}/docs/ja/${page.file}`; enToJa.set(enPath, jaPath); } } diff --git a/scripts/build-output.test.ts b/scripts/build-output.test.ts index 4bb882b..c77e2a8 100644 --- a/scripts/build-output.test.ts +++ b/scripts/build-output.test.ts @@ -2,29 +2,26 @@ import assert from 'node:assert/strict'; import { access, constants, readdir, readFile, stat } from 'node:fs/promises'; import { join } from 'node:path'; import test from 'node:test'; -import { CURRENT_SPONSORS, PAST_SPONSORS } from '../src/app/generated/sponsors.generated'; +import { + CURRENT_SPONSORS, + PAST_SPONSORS, +} from '../projects/docs/src/app/generated/sponsors.generated'; test('places locale-specific static 404 pages in the browser output', async () => { const [english, japanese] = await Promise.all([ - readFile(new URL('../dist/capacitor-plugins-docs/browser/404.html', import.meta.url), 'utf8'), - readFile( - new URL('../dist/capacitor-plugins-docs/browser/ja/404.html', import.meta.url), - 'utf8', - ), + readFile(new URL('../dist/docs/browser/404.html', import.meta.url), 'utf8'), + readFile(new URL('../dist/docs/browser/ja/404.html', import.meta.url), 'utf8'), ]); assert.match(english, //); assert.match(japanese, //); await assert.rejects(() => - access( - new URL('../dist/capacitor-plugins-docs/browser/ja/ja/404.html', import.meta.url), - constants.F_OK, - ), + access(new URL('../dist/docs/browser/ja/ja/404.html', import.meta.url), constants.F_OK), ); }); test('legacy prerender output redirects to an absolute canonical route', async () => { const html = await readFile( - new URL('../dist/capacitor-plugins-docs/browser/stripe/docs/react/index.html', import.meta.url), + new URL('../dist/docs/browser/stripe/docs/react/index.html', import.meta.url), 'utf8', ); assert.match(html, /\/projects\/capacitor-stripe\/docs\/react/); @@ -33,10 +30,7 @@ test('legacy prerender output redirects to an absolute canonical route', async ( test('prerender output includes localized SEO metadata', async () => { const html = await readFile( - new URL( - '../dist/capacitor-plugins-docs/browser/ja/projects/capacitor-admob/index.html', - import.meta.url, - ), + new URL('../dist/docs/browser/ja/projects/capacitor-admob/index.html', import.meta.url), 'utf8', ); assert.match(html, / { test('prerenders current and past public sponsors in both locales', async () => { const [english, japanese] = await Promise.all([ - readFile( - new URL('../dist/capacitor-plugins-docs/browser/support/index.html', import.meta.url), - 'utf8', - ), - readFile( - new URL('../dist/capacitor-plugins-docs/browser/ja/support/index.html', import.meta.url), - 'utf8', - ), + readFile(new URL('../dist/docs/browser/support/index.html', import.meta.url), 'utf8'), + readFile(new URL('../dist/docs/browser/ja/support/index.html', import.meta.url), 'utf8'), ]); for (const html of [english, japanese]) { @@ -83,7 +71,7 @@ test('prerenders current and past public sponsors in both locales', async () => test('Japanese home prerender uses slashless canonical SEO URLs', async () => { const html = await readFile( - new URL('../dist/capacitor-plugins-docs/browser/ja/index.html', import.meta.url), + new URL('../dist/docs/browser/ja/index.html', import.meta.url), 'utf8', ); assert.match(html, /rel="canonical" href="https:\/\/docs\.rdlabo\.dev\/ja"/); @@ -97,10 +85,7 @@ test('Japanese home prerender uses slashless canonical SEO URLs', async () => { }); test('prerendered docs shell stays layout-neutral before bootstrap', async () => { - const html = await readFile( - new URL('../dist/capacitor-plugins-docs/browser/index.html', import.meta.url), - 'utf8', - ); + const html = await readFile(new URL('../dist/docs/browser/index.html', import.meta.url), 'utf8'); const shell = html.match(/]*\bclass="[^"]*\bdocs-shell\b[^"]*"[^>]*>/)?.[0]; assert.ok(shell, 'docs-shell must be present in prerendered index.html'); assert.doesNotMatch(shell, /\blayout-ready\b/); @@ -115,7 +100,7 @@ test('prerendered docs shell stays layout-neutral before bootstrap', async () => assert.match(sidebar, /lg:translate-x-0/); assert.doesNotMatch(sidebar, /\binert\b/); - const css = await readFile(new URL('../src/app/app.css', import.meta.url), 'utf8'); + const css = await readFile(new URL('../projects/docs/src/app/app.css', import.meta.url), 'utf8'); assert.match( css, /@media\s*\(\s*max-width:\s*1023px\s*\)[\s\S]*?\.docs-shell:not\(\.layout-ready\)\s+#docs-sidebar\s*\{[\s\S]*?visibility:\s*hidden;[\s\S]*?transform:\s*translateX\(-100%\);/, @@ -125,7 +110,7 @@ test('prerendered docs shell stays layout-neutral before bootstrap', async () => test('prerendered locales include reusable hydration data', async () => { const pages = await Promise.all( ['index.html', 'ja/index.html'].map((path) => - readFile(new URL(`../dist/capacitor-plugins-docs/browser/${path}`, import.meta.url), 'utf8'), + readFile(new URL(`../dist/docs/browser/${path}`, import.meta.url), 'utf8'), ), ); @@ -143,10 +128,7 @@ test('prerendered locales include reusable hydration data', async () => { }); test('builds bounded English and Japanese search indexes with the component UI', async () => { - const searchDirectory = new URL( - '../dist/capacitor-plugins-docs/browser/pagefind/', - import.meta.url, - ); + const searchDirectory = new URL('../dist/docs/browser/pagefind/', import.meta.url); const files = await readdir(searchDirectory, { recursive: true }); assert.ok(files.includes('pagefind-component-ui.js')); assert.ok(files.includes('pagefind-component-ui.css')); diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts index 8613b7c..af3d4a8 100644 --- a/scripts/generate-docs.ts +++ b/scripts/generate-docs.ts @@ -13,8 +13,8 @@ import { type ProjectDefinition, type ProjectPageDefinition, } from './project-manifest'; -import { localizedPublicPath } from '../src/app/locale-path'; -import { SITE_CONFIG } from '../src/app/site-config'; +import { localizedPublicPath } from '../projects/docs/src/app/locale-path'; +import { SITE_CONFIG } from '../projects/docs/src/app/site-config'; import { enforceGeneratedHtmlPolicy } from './html-policy'; import { normalizeImportedReadmeHeadings } from './markdown-headings'; import { splitDocgenReadme } from './docgen-readme'; @@ -277,7 +277,7 @@ function landingPageSlug(project: ProjectDefinition): string { function srcDocsPath(project: ProjectDefinition, locale: Locale, file: string): string { return join( root, - 'src', + 'projects/docs/src', project.sourceDirectory, 'docs', ...(locale === 'ja' ? ['ja'] : []), @@ -485,7 +485,10 @@ async function generateProject(project: ProjectDefinition, locale: Locale): Prom const normalized = String(codePath).replace(/^\/docs\/stripe\//, ''); codes.push( await renderCode( - await readFile(join(root, 'src', project.sourceDirectory, 'docs', normalized), 'utf8'), + await readFile( + join(root, 'projects/docs/src', project.sourceDirectory, 'docs', normalized), + 'utf8', + ), ), ); } @@ -582,7 +585,7 @@ async function generateProject(project: ProjectDefinition, locale: Locale): Prom } async function main(): Promise { - const generatedDirectory = join(root, 'src/app/generated'); + const generatedDirectory = join(root, 'projects/docs/src/app/generated'); const projectsDirectory = join(generatedDirectory, 'projects'); await mkdir(projectsDirectory, { recursive: true }); const projectsByLocale: Record = { en: [], ja: [] }; @@ -651,11 +654,11 @@ async function main(): Promise { }) .join('\n'); await writeFile( - join(root, 'public/sitemap.xml'), + join(root, 'projects/docs/public/sitemap.xml'), `\n\n${sitemapEntries}\n\n`, ); await writeFile( - join(root, 'public/robots.txt'), + join(root, 'projects/docs/public/robots.txt'), `User-agent: *\nAllow: /\n\nSitemap: ${SITE_CONFIG.origin}/sitemap.xml\n`, ); const pageCount = projectsByLocale.en.reduce((count, project) => count + project.pages.length, 0); diff --git a/scripts/generate-sponsors.ts b/scripts/generate-sponsors.ts index 9df7b09..289e972 100644 --- a/scripts/generate-sponsors.ts +++ b/scripts/generate-sponsors.ts @@ -2,9 +2,13 @@ import { writeFile } from 'node:fs/promises'; import { join } from 'node:path'; import { fetchPublicSponsors, sponsorsModule } from './github-sponsors'; -const outputPath = join(process.cwd(), 'src/app/generated/sponsors.generated.ts'); -const sponsors = await fetchPublicSponsors('rdlabo', process.env['GITHUB_TOKEN'] ?? ''); -await writeFile(outputPath, sponsorsModule(sponsors)); -console.log( - `Generated ${sponsors.current.length} current and ${sponsors.past.length} past public sponsors.`, -); +async function main(): Promise { + const outputPath = join(process.cwd(), 'projects/docs/src/app/generated/sponsors.generated.ts'); + const sponsors = await fetchPublicSponsors('rdlabo', process.env['GITHUB_TOKEN'] ?? ''); + await writeFile(outputPath, sponsorsModule(sponsors)); + console.log( + `Generated ${sponsors.current.length} current and ${sponsors.past.length} past public sponsors.`, + ); +} + +void main(); diff --git a/scripts/package-repository.test.ts b/scripts/package-repository.test.ts index 94a8a70..b845b37 100644 --- a/scripts/package-repository.test.ts +++ b/scripts/package-repository.test.ts @@ -73,7 +73,7 @@ test('keeps fork-fetched portal pages editable in the canonical repository', () }), { content: '# API', - repositoryPath: 'src/example/docs/api.md', + repositoryPath: 'projects/docs/src/example/docs/api.md', repositoryRef: 'main', repositoryUrl: 'https://github.com/rdlabo-dev/website', }, diff --git a/scripts/package-repository.ts b/scripts/package-repository.ts index 80dc65d..c754d42 100644 --- a/scripts/package-repository.ts +++ b/scripts/package-repository.ts @@ -24,7 +24,7 @@ function localPortalRef(): string { export const DOCS_PORTAL_REF = process.env['RDLABO_DOCS_REF'] ?? localPortalRef(); -const portalDocsRoot = join(process.cwd(), 'src'); +const portalDocsRoot = join(process.cwd(), 'projects/docs/src'); const pinnedVersionCache = new Map(); async function pinnedVersionFor(packageName: string): Promise { @@ -82,6 +82,14 @@ async function portalEnglishTrackedLocally( } } +function portalRepositoryPath(sourceDirectory: string, file: string): string { + return `projects/docs/src/${sourceDirectory}/docs/${file}`; +} + +function legacyPortalRepositoryPath(sourceDirectory: string, file: string): string { + return `src/${sourceDirectory}/docs/${file}`; +} + export interface FetchedEnglishMarkdown { content: string; repositoryPath: string; @@ -89,9 +97,18 @@ export interface FetchedEnglishMarkdown { repositoryUrl: string; } -export function canonicalizePortalSource(source: FetchedEnglishMarkdown): FetchedEnglishMarkdown { +export function canonicalizePortalSource( + source: FetchedEnglishMarkdown, + sourceDirectory?: string, + file?: string, +): FetchedEnglishMarkdown { + const repositoryPath = + sourceDirectory && file + ? portalRepositoryPath(sourceDirectory, file) + : source.repositoryPath.replace(/^src\//, 'projects/docs/src/'); return { ...source, + repositoryPath, repositoryUrl: CANONICAL_DOCS_PORTAL_REPOSITORY_URL, repositoryRef: 'main', }; @@ -263,15 +280,17 @@ export async function fetchEnglishProjectMarkdown( } if (await portalEnglishTrackedLocally(project.sourceDirectory, file)) { - const portalPath = `src/${project.sourceDirectory}/docs/${file}`; const fromPortal = await fetchFirstRepositoryPath( DOCS_PORTAL_REPOSITORY_URL, DOCS_PORTAL_REF, - [portalPath], + [ + portalRepositoryPath(project.sourceDirectory, file), + legacyPortalRepositoryPath(project.sourceDirectory, file), + ], cache, ); if (fromPortal) { - return canonicalizePortalSource(fromPortal); + return canonicalizePortalSource(fromPortal, project.sourceDirectory, file); } } @@ -301,9 +320,16 @@ export async function fetchEnglishProjectReadme( ? await fetchFirstRepositoryPath( DOCS_PORTAL_REPOSITORY_URL, DOCS_PORTAL_REF, - [`src/${project.sourceDirectory}/docs/readme.md`], + [ + portalRepositoryPath(project.sourceDirectory, 'readme.md'), + legacyPortalRepositoryPath(project.sourceDirectory, 'readme.md'), + ], cache, - ).then((result) => (result ? canonicalizePortalSource(result) : undefined)) + ).then((result) => + result + ? canonicalizePortalSource(result, project.sourceDirectory, 'readme.md') + : undefined, + ) : undefined) ?? (await fetchFirstRepositoryPath( project.repositoryUrl, diff --git a/scripts/site-contract.test.ts b/scripts/site-contract.test.ts index e71f077..4d89f39 100644 --- a/scripts/site-contract.test.ts +++ b/scripts/site-contract.test.ts @@ -94,8 +94,8 @@ test('pins every documentation source to the installed package version', async ( test('serves locale-specific static 404 pages', async () => { const [english, japanese] = await Promise.all([ - readFile(new URL('../public/404.html', import.meta.url), 'utf8'), - readFile(new URL('../public/ja/404.html', import.meta.url), 'utf8'), + readFile(new URL('../projects/docs/public/404.html', import.meta.url), 'utf8'), + readFile(new URL('../projects/docs/public/ja/404.html', import.meta.url), 'utf8'), ]); assert.match(english, //); assert.match(japanese, //); @@ -105,7 +105,7 @@ test('serves locale-specific static 404 pages', async () => { test('rdlabo brand logo title is English-only', async () => { const svg = await readFile( - new URL('../public/assets/brand/rdlabo-logo.svg', import.meta.url), + new URL('../projects/docs/public/assets/brand/rdlabo-logo.svg', import.meta.url), 'utf8', ); assert.match(svg, /]*>rdlabo\.dev logo<\/title>/); @@ -119,7 +119,7 @@ test('uses the rdlabo-dev GitHub owner throughout site sources', async () => { const roots = [ new URL('../README.md', import.meta.url), new URL('../scripts/', import.meta.url), - new URL('../src/', import.meta.url), + new URL('../projects/docs/src/', import.meta.url), ]; const files = [roots[0]]; for (const root of roots.slice(1)) { @@ -156,9 +156,9 @@ test('uses the rdlabo-dev GitHub owner throughout site sources', async () => { test('favicon brand assets are wired for rdlabo.dev', async () => { const [indexHtml, appleTouchIcon, faviconIco] = await Promise.all([ - readFile(new URL('../src/index.html', import.meta.url), 'utf8'), - readFile(new URL('../public/assets/brand/apple-touch-icon.png', import.meta.url)), - readFile(new URL('../public/favicon.ico', import.meta.url)), + readFile(new URL('../projects/docs/src/index.html', import.meta.url), 'utf8'), + readFile(new URL('../projects/docs/public/assets/brand/apple-touch-icon.png', import.meta.url)), + readFile(new URL('../projects/docs/public/favicon.ico', import.meta.url)), ]); assert.match( @@ -186,10 +186,16 @@ test('favicon brand assets are wired for rdlabo.dev', async () => { assert.equal(faviconIco.readUInt32BE(20), 64); await assert.rejects(() => - access(new URL('../public/assets/icon/favicon.ico', import.meta.url), constants.F_OK), + access( + new URL('../projects/docs/public/assets/icon/favicon.ico', import.meta.url), + constants.F_OK, + ), ); await assert.rejects(() => - access(new URL('../public/assets/icon/favicon.png', import.meta.url), constants.F_OK), + access( + new URL('../projects/docs/public/assets/icon/favicon.png', import.meta.url), + constants.F_OK, + ), ); }); @@ -229,7 +235,7 @@ test('imports every installed ESLint rule README with matching EN/JA code fences assert.equal(manifestRuleNames.length, 19); assert.deepEqual(manifestRuleNames, installedRuleNames); - const docsRoot = new URL('../src/eslint-plugin-rules/docs/', import.meta.url); + const docsRoot = new URL('../projects/docs/src/eslint-plugin-rules/docs/', import.meta.url); const [englishRulesIndex, japaneseRulesIndex] = await Promise.all([ englishGuideSource(eslintProject, 'rules.md'), readFile(new URL('ja/rules.md', docsRoot), 'utf8'), @@ -321,7 +327,7 @@ test('lists every ionic-angular-library package and imports localized READMEs', for (const project of projectDefinitions) { const documentedSource = project.hostedUrl ? project.repositoryUrl.replace('https://github.com/', '') - : `src/${project.sourceDirectory}/docs`; + : `projects/docs/src/${project.sourceDirectory}/docs`; assert.ok( repositoryReadme.includes(`| ${project.name} | \`${documentedSource}\` |`), `README Current projects must list ${project.name}`, @@ -351,7 +357,7 @@ test('lists every ionic-angular-library package and imports localized READMEs', ]) { const project = libraryProjects.find((entry) => entry.id === projectId); assert.ok(project); - const docsRoot = new URL(`../src/${projectId}/docs/`, import.meta.url); + const docsRoot = new URL(`../projects/docs/src/${projectId}/docs/`, import.meta.url); const pageFiles = project.pages.map((page) => page.file).filter((file) => file !== 'api.md'); const allEnglish: string[] = []; const allJapanese: string[] = []; @@ -436,7 +442,7 @@ test('lists ionic theme packages and pins localized README imports', async () => ) as { version: string }; assert.equal(installedPackage.version, expected.version); - const docsRoot = new URL(`../src/${projectId}/docs/`, import.meta.url); + const docsRoot = new URL(`../projects/docs/src/${projectId}/docs/`, import.meta.url); const pageFiles = project.pages.map((page) => page.file).filter((file) => file !== 'api.md'); for (const pageFile of pageFiles) { const [english, japanese] = await Promise.all([ @@ -484,14 +490,23 @@ test('lists ionic theme packages and pins localized README imports', async () => const [iosReadme, _iosReadmeJa, usingDoc, usingDocJa, iosMigration, iosMigrationJa] = await Promise.all([ englishGuideSource(iosProject, 'readme.md'), - readFile(new URL('../src/ionic-theme-ios26/docs/ja/readme.md', import.meta.url), 'utf8'), + readFile( + new URL('../projects/docs/src/ionic-theme-ios26/docs/ja/readme.md', import.meta.url), + 'utf8', + ), englishGuideSource(iosProject, 'using-ion-item-group.md'), readFile( - new URL('../src/ionic-theme-ios26/docs/ja/using-ion-item-group.md', import.meta.url), + new URL( + '../projects/docs/src/ionic-theme-ios26/docs/ja/using-ion-item-group.md', + import.meta.url, + ), 'utf8', ), englishGuideSource(iosProject, 'migration.md'), - readFile(new URL('../src/ionic-theme-ios26/docs/ja/migration.md', import.meta.url), 'utf8'), + readFile( + new URL('../projects/docs/src/ionic-theme-ios26/docs/ja/migration.md', import.meta.url), + 'utf8', + ), ]); assert.match(iosReadme, /\]\(\/docs\/using-ion-item-group\)/); assert.match( @@ -591,7 +606,7 @@ test('imports the remaining rdlabo utility READMEs from exact public releases', ) as { version: string }; assert.equal(installedPackage.version, version); - const docsRoot = new URL(`../src/${projectId}/docs/`, import.meta.url); + const docsRoot = new URL(`../projects/docs/src/${projectId}/docs/`, import.meta.url); const pageFiles = project.pages.map((page) => page.file).filter((file) => file !== 'api.md'); for (const pageFile of pageFiles) { const japanese = await readFile(new URL(`ja/${pageFile}`, docsRoot), 'utf8'); @@ -620,7 +635,7 @@ test('imports the remaining rdlabo utility READMEs from exact public releases', const project = projectDefinitions.find((entry) => entry.id === projectId); assert.ok(project, `${projectId} must be declared`); const japanese = await readFile( - new URL(`../src/${projectId}/docs/ja/${file}`, import.meta.url), + new URL(`../projects/docs/src/${projectId}/docs/ja/${file}`, import.meta.url), 'utf8', ); const english = await englishGuideSource(project, file); @@ -829,12 +844,15 @@ test('documents the exact capacitor-docgen inheritance enhancement over upstream readFile(join(forkPackageDirectory, 'dist', 'types.d.ts'), 'utf8'), englishGuideSource(docgenProject, 'upstream-differences.md'), readFile( - new URL('../src/capacitor-docgen/docs/ja/upstream-differences.md', import.meta.url), + new URL( + '../projects/docs/src/capacitor-docgen/docs/ja/upstream-differences.md', + import.meta.url, + ), 'utf8', ), englishGuideSource(docgenProject, 'getting-started.md'), readFile( - new URL('../src/capacitor-docgen/docs/ja/getting-started.md', import.meta.url), + new URL('../projects/docs/src/capacitor-docgen/docs/ja/getting-started.md', import.meta.url), 'utf8', ), ]); @@ -898,7 +916,7 @@ test('configures Cloudflare Workers Static Assets for docs.rdlabo.dev', async () assert.equal(wrangler.compatibility_date, '2026-08-15'); assert.equal(wrangler.workers_dev, false); assert.equal(wrangler.preview_urls, false); - assert.equal(wrangler.assets?.directory, './dist/capacitor-plugins-docs/browser'); + assert.equal(wrangler.assets?.directory, './dist/docs/browser'); assert.equal(wrangler.assets?.not_found_handling, '404-page'); assert.equal(wrangler.assets?.html_handling, 'drop-trailing-slash'); assert.deepEqual(wrangler.routes, [{ pattern: 'docs.rdlabo.dev', custom_domain: true }]); @@ -908,7 +926,7 @@ test('configures Cloudflare Workers Static Assets for docs.rdlabo.dev', async () 'npm run build && wrangler deploy --dry-run', ); await assert.rejects(() => - access(new URL('../public/_redirects', import.meta.url), constants.F_OK), + access(new URL('../projects/docs/public/_redirects', import.meta.url), constants.F_OK), ); }); @@ -961,9 +979,9 @@ test('uses docs.rdlabo.dev as the canonical origin in site SEO outputs', async ( const legacyOrigin = 'https://stripe.capacitorjs.jp'; const canonicalOrigin = 'https://docs.rdlabo.dev'; const [siteConfig, sitemap, robots] = await Promise.all([ - readFile(new URL('../src/app/site-config.ts', import.meta.url), 'utf8'), - readFile(new URL('../public/sitemap.xml', import.meta.url), 'utf8'), - readFile(new URL('../public/robots.txt', import.meta.url), 'utf8'), + readFile(new URL('../projects/docs/src/app/site-config.ts', import.meta.url), 'utf8'), + readFile(new URL('../projects/docs/public/sitemap.xml', import.meta.url), 'utf8'), + readFile(new URL('../projects/docs/public/robots.txt', import.meta.url), 'utf8'), ]); assert.match(siteConfig, new RegExp(`origin:\\s*'${canonicalOrigin.replaceAll('.', '\\.')}'`)); @@ -993,7 +1011,7 @@ test('locks production anyScript budgets after catalog growth', async () => { await readFile(new URL('../angular.json', import.meta.url), 'utf8'), ) as { projects: { - 'capacitor-plugins-docs': { + docs: { architect: { build: { configurations: { @@ -1011,7 +1029,7 @@ test('locks production anyScript budgets after catalog growth', async () => { }; }; const anyScript = angularJson.projects[ - 'capacitor-plugins-docs' + 'docs' ].architect.build.configurations.production.budgets.find((budget) => budget.type === 'anyScript'); assert.ok(anyScript); assert.equal(anyScript.maximumWarning, '425kB'); @@ -1063,16 +1081,16 @@ test('loads Facebook Login guides and API from the package repository', async () assert.match(extracted.api ?? '', /^### logEvent\(\.\.\.\)$/m); }); -test('package-hosted English docs are not duplicated under src', async () => { +test('package-hosted English docs are not duplicated under projects/docs/src', async () => { for (const project of projectDefinitions.filter((entry) => packageEnglishOnlyProjects.has(entry.id), )) { - const srcDocs = new URL(`../src/${project.id}/docs/`, import.meta.url); + const srcDocs = new URL(`../projects/docs/src/${project.id}/docs/`, import.meta.url); const englishFiles = (await readdir(srcDocs)).filter((name) => name.endsWith('.md')); assert.deepEqual( englishFiles.sort(), [], - `${project.id} must not store English Markdown under src/${project.id}/docs/`, + `${project.id} must not store English Markdown under projects/docs/src/${project.id}/docs/`, ); for (const page of project.pages) { @@ -1101,7 +1119,7 @@ test('loads AdMob English pages from GitHub', async () => { ], ); - const srcDocs = new URL('../src/admob/docs/', import.meta.url); + const srcDocs = new URL('../projects/docs/src/admob/docs/', import.meta.url); const englishFiles = (await readdir(srcDocs)).filter((name) => name.endsWith('.md')); assert.deepEqual(englishFiles.sort(), []); await assert.rejects(() => access(new URL('full-screen-ads.md', srcDocs), constants.F_OK)); diff --git a/scripts/static-prepare.ts b/scripts/static-prepare.ts index c070e0b..a7dc3d5 100644 --- a/scripts/static-prepare.ts +++ b/scripts/static-prepare.ts @@ -3,8 +3,8 @@ import { dirname, join } from 'node:path'; import { fileURLToPath } from 'node:url'; const repoRoot = join(dirname(fileURLToPath(import.meta.url)), '..'); -const source404 = join(repoRoot, 'public', 'ja', '404.html'); -const browserRoot = join(repoRoot, 'dist', 'capacitor-plugins-docs', 'browser'); +const source404 = join(repoRoot, 'projects/docs/public', 'ja', '404.html'); +const browserRoot = join(repoRoot, 'dist', 'docs', 'browser'); const target404 = join(browserRoot, 'ja', '404.html'); const nestedJaDirectory = join(browserRoot, 'ja', 'ja'); diff --git a/tsconfig.json b/tsconfig.json index c26d114..5edce47 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -20,5 +20,8 @@ "strictTemplates": true }, "files": [], - "references": [{ "path": "./tsconfig.app.json" }, { "path": "./tsconfig.spec.json" }] + "references": [ + { "path": "./projects/docs/tsconfig.app.json" }, + { "path": "./projects/docs/tsconfig.spec.json" } + ] } diff --git a/wrangler.jsonc b/wrangler.jsonc index d85a507..ace3e9f 100644 --- a/wrangler.jsonc +++ b/wrangler.jsonc @@ -6,7 +6,7 @@ "workers_dev": false, "preview_urls": false, "assets": { - "directory": "./dist/capacitor-plugins-docs/browser", + "directory": "./dist/docs/browser", "not_found_handling": "404-page", "html_handling": "drop-trailing-slash", }, From 4ec2f1eafcd8c4d9d4de9c05521fc2c5e0a33bbe Mon Sep 17 00:00:00 2001 From: rdlabo Date: Sat, 22 Aug 2026 18:52:01 +0900 Subject: [PATCH 2/2] fix: parse docgen HTML safely --- .../docs/src/app/generated/projects/admob.ja.generated.ts | 4 ++-- .../projects/capacitor-brotherprint.ja.generated.ts | 4 ++-- .../projects/capacitor-codescanner.ja.generated.ts | 2 +- .../projects/capacitor-screenshot-event.ja.generated.ts | 2 +- .../generated/projects/stripe-identity.en.generated.ts | 2 +- .../generated/projects/stripe-identity.ja.generated.ts | 2 +- .../generated/projects/stripe-terminal.en.generated.ts | 2 +- .../generated/projects/stripe-terminal.ja.generated.ts | 2 +- .../src/app/generated/projects/stripe.en.generated.ts | 4 ++-- .../src/app/generated/projects/stripe.ja.generated.ts | 4 ++-- scripts/generate-docs.ts | 8 +++++++- 11 files changed, 21 insertions(+), 15 deletions(-) diff --git a/projects/docs/src/app/generated/projects/admob.ja.generated.ts b/projects/docs/src/app/generated/projects/admob.ja.generated.ts index 5d525e7..83e7912 100644 --- a/projects/docs/src/app/generated/projects/admob.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/admob.ja.generated.ts @@ -310,7 +310,7 @@ export const PROJECT = { "file": "rewarded.md", "section": "広告フォーマット", "path": "/projects/capacitor-admob/docs/rewarded", - "html": "

リワード広告は、動画・プレイアブル・アンケートへの操作と引き換えにアプリ内アイテムを渡す形式です。形式の説明は Google のリワード広告ガイド(Android / iOS)を見てください。

\n

リワード広告は報酬フローとして扱い、報酬なしのインタースティシャルの代わりにはしません。初期化同意 のあとで呼び出します。報酬は戻り値または Rewarded イベントからのみ付与し、Dismissed では付与しません。

\n

リワード動画

\n

専用の報酬フローではリワード広告を使います。

\n
import {\n  AdLoadInfo,\n  AdMob,\n  AdMobRevenueData,\n  AdMobRewardItem,\n  RewardAdOptions,\n  RewardAdPluginEvents,\n} from '@capacitor-community/admob';\n\nawait AdMob.addListener(RewardAdPluginEvents.Loaded, (info: AdLoadInfo) => {\n  console.log('Rewarded ad loaded', info.adUnitId);\n});\nawait AdMob.addListener(RewardAdPluginEvents.FailedToLoad, console.error);\nawait AdMob.addListener(RewardAdPluginEvents.Rewarded, (reward: AdMobRewardItem) => {\n  console.log('Reward earned', reward.amount, reward.type);\n});\nawait AdMob.addListener(RewardAdPluginEvents.AdImpression, (data: AdMobRevenueData) => {\n  console.log(data);\n});\n\nconst options: RewardAdOptions = {\n  adId: 'YOUR_AD_UNIT_ID',\n  // isTesting: true,\n  // npa: true,\n  // immersiveMode: true,\n  // ssv: {\n  //   userId: 'USER_ID',\n  //   customData: JSON.stringify({ placement: 'bonus' }),\n  // },\n};\nawait AdMob.prepareRewardVideoAd(options);\nconst rewardItem = await AdMob.showRewardVideoAd();\n// Grant the reward once, using this result or the Rewarded event — not both.\nconsole.log(rewardItem);\n

method prepareRewardVideoAd(...)

Loads a rewarded ad and returns the loaded ad unit ID.

prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>

\n\n\n

method showRewardVideoAd(...)

Shows a loaded rewarded ad and resolves when the user earns the reward.

showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>

\n\n\n

interface RewardAdOptions

Options for loading a rewarded ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
ssvAtLeastOne&lt;{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }&gt;Server-side verification options for the rewarded ad. Provide at least one of userId or customData.
adIdstringThe ad unit ID to load.1.1.2
isTestingbooleanWhether to request a test ad.false1.1.2
marginnumberThe banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin.01.1.2
npabooleanWhether to request non-personalized ads.false1.2.0
immersiveModebooleanWhether to display a full-screen ad in immersive mode on Android.7.0.3
\n\n\n

interface AdMobRewardItem

The reward earned by the user after viewing a rewarded ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
typestringThe reward item type configured for the ad unit.
amountnumberThe reward amount earned by the user.

showRewardVideoAd()adId を渡さないと、最後に準備した広告を表示します。

\n\n\n\n

複数の広告を準備する

\n
await AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });\nawait AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-2' });\n\nconst reward = await AdMob.showRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });\n

リワード付きインタースティシャル

\n

リワード付きインタースティシャルは、自然な遷移で自動表示される報酬付きフルスクリーン広告です。通常のリワードと違い、視聴のオプトインは不要です。形式の説明は Google のリワード付きインタースティシャルガイド(Android / iOS)を見てください。

\n

報酬体験がアプリの自然な遷移に乗る場合は、リワード付きインタースティシャルを使います。

\n
import {\n  AdMob,\n  AdMobRewardInterstitialItem,\n  RewardInterstitialAdOptions,\n  RewardInterstitialAdPluginEvents,\n} from '@capacitor-community/admob';\n\nawait AdMob.addListener(RewardInterstitialAdPluginEvents.FailedToLoad, console.error);\n\nconst options: RewardInterstitialAdOptions = {\n  adId: 'YOUR_AD_UNIT_ID',\n};\nconst { adUnitId } = await AdMob.prepareRewardInterstitialAd(options);\nconst rewardItem: AdMobRewardInterstitialItem = await AdMob.showRewardInterstitialAd({\n  adId: adUnitId,\n});\nconsole.log(rewardItem);\n

method prepareRewardInterstitialAd(...)

Loads a rewarded interstitial ad and returns the loaded ad unit ID.

prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>

\n\n\n

method showRewardInterstitialAd(...)

Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.

showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>

\n\n\n

interface RewardInterstitialAdOptions

Options for loading a rewarded interstitial ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
ssvAtLeastOne&lt;{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }&gt;Server-side verification options for the rewarded interstitial ad. Provide at least one of userId or customData.
adIdstringThe ad unit ID to load.1.1.2
isTestingbooleanWhether to request a test ad.false1.1.2
marginnumberThe banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin.01.1.2
npabooleanWhether to request non-personalized ads.false1.2.0
immersiveModebooleanWhether to display a full-screen ad in immersive mode on Android.7.0.3
\n\n\n

interface AdMobRewardInterstitialItem

The reward earned by the user after viewing a rewarded interstitial ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
typestringThe reward item type configured for the ad unit.
amountnumberThe reward amount earned by the user.

isTestingテスト を参照してください。

\n\n\n\n

サーバーサイド検証

\n

サーバーサイド検証(SSV)は、報酬が得られたことをバックエンドで確認するための仕組みです。Google の SSV の説明 を見てください。コールバックは本番広告でのみ送られ、テスト広告では SSV エンドポイントは呼ばれません。

\n

ssv のペイロードをローカルで確認するには、RewardAdPluginEvents.Rewarded のあとにモックリクエストを送れます。ENVIRONMENT_IS_DEVELOPMENT は自分の開発用フラグに置き換えてください。

\n
const userId = 'USER_ID';\nconst customData = JSON.stringify({ placement: 'bonus' });\n\nawait AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {\n  if (!ENVIRONMENT_IS_DEVELOPMENT) {\n    return;\n  }\n  try {\n    const params = new URLSearchParams({\n      ad_network: 'TEST',\n      ad_unit: 'TEST',\n      custom_data: customData,\n      reward_amount: 'TEST',\n      reward_item: 'TEST',\n      timestamp: 'TEST',\n      transaction_id: 'TEST',\n      user_id: userId,\n      signature: 'TEST',\n      key_id: 'TEST',\n    });\n    await fetch(`https://your-staging-ssv-endpoint?${params.toString()}`);\n  } catch (err) {\n    console.error(err);\n  }\n});\n
", + "html": "

リワード広告は、動画・プレイアブル・アンケートへの操作と引き換えにアプリ内アイテムを渡す形式です。形式の説明は Google のリワード広告ガイド(Android / iOS)を見てください。

\n

リワード広告は報酬フローとして扱い、報酬なしのインタースティシャルの代わりにはしません。初期化同意 のあとで呼び出します。報酬は戻り値または Rewarded イベントからのみ付与し、Dismissed では付与しません。

\n

リワード動画

\n

専用の報酬フローではリワード広告を使います。

\n
import {\n  AdLoadInfo,\n  AdMob,\n  AdMobRevenueData,\n  AdMobRewardItem,\n  RewardAdOptions,\n  RewardAdPluginEvents,\n} from '@capacitor-community/admob';\n\nawait AdMob.addListener(RewardAdPluginEvents.Loaded, (info: AdLoadInfo) => {\n  console.log('Rewarded ad loaded', info.adUnitId);\n});\nawait AdMob.addListener(RewardAdPluginEvents.FailedToLoad, console.error);\nawait AdMob.addListener(RewardAdPluginEvents.Rewarded, (reward: AdMobRewardItem) => {\n  console.log('Reward earned', reward.amount, reward.type);\n});\nawait AdMob.addListener(RewardAdPluginEvents.AdImpression, (data: AdMobRevenueData) => {\n  console.log(data);\n});\n\nconst options: RewardAdOptions = {\n  adId: 'YOUR_AD_UNIT_ID',\n  // isTesting: true,\n  // npa: true,\n  // immersiveMode: true,\n  // ssv: {\n  //   userId: 'USER_ID',\n  //   customData: JSON.stringify({ placement: 'bonus' }),\n  // },\n};\nawait AdMob.prepareRewardVideoAd(options);\nconst rewardItem = await AdMob.showRewardVideoAd();\n// Grant the reward once, using this result or the Rewarded event — not both.\nconsole.log(rewardItem);\n

method prepareRewardVideoAd(...)

Loads a rewarded ad and returns the loaded ad unit ID.

prepareRewardVideoAd(options: RewardAdOptions) => Promise<AdLoadInfo>

\n\n\n

method showRewardVideoAd(...)

Shows a loaded rewarded ad and resolves when the user earns the reward.

showRewardVideoAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardItem>

\n\n\n

interface RewardAdOptions

Options for loading a rewarded ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
ssvAtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }>Server-side verification options for the rewarded ad. Provide at least one of userId or customData.
adIdstringThe ad unit ID to load.1.1.2
isTestingbooleanWhether to request a test ad.false1.1.2
marginnumberThe banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin.01.1.2
npabooleanWhether to request non-personalized ads.false1.2.0
immersiveModebooleanWhether to display a full-screen ad in immersive mode on Android.7.0.3
\n\n\n

interface AdMobRewardItem

The reward earned by the user after viewing a rewarded ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
typestringThe reward item type configured for the ad unit.
amountnumberThe reward amount earned by the user.

showRewardVideoAd()adId を渡さないと、最後に準備した広告を表示します。

\n\n\n\n

複数の広告を準備する

\n
await AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });\nawait AdMob.prepareRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-2' });\n\nconst reward = await AdMob.showRewardVideoAd({ adId: 'ca-app-pub-xxx/reward-1' });\n

リワード付きインタースティシャル

\n

リワード付きインタースティシャルは、自然な遷移で自動表示される報酬付きフルスクリーン広告です。通常のリワードと違い、視聴のオプトインは不要です。形式の説明は Google のリワード付きインタースティシャルガイド(Android / iOS)を見てください。

\n

報酬体験がアプリの自然な遷移に乗る場合は、リワード付きインタースティシャルを使います。

\n
import {\n  AdMob,\n  AdMobRewardInterstitialItem,\n  RewardInterstitialAdOptions,\n  RewardInterstitialAdPluginEvents,\n} from '@capacitor-community/admob';\n\nawait AdMob.addListener(RewardInterstitialAdPluginEvents.FailedToLoad, console.error);\n\nconst options: RewardInterstitialAdOptions = {\n  adId: 'YOUR_AD_UNIT_ID',\n};\nconst { adUnitId } = await AdMob.prepareRewardInterstitialAd(options);\nconst rewardItem: AdMobRewardInterstitialItem = await AdMob.showRewardInterstitialAd({\n  adId: adUnitId,\n});\nconsole.log(rewardItem);\n

method prepareRewardInterstitialAd(...)

Loads a rewarded interstitial ad and returns the loaded ad unit ID.

prepareRewardInterstitialAd(options: RewardInterstitialAdOptions) => Promise<AdLoadInfo>

\n\n\n

method showRewardInterstitialAd(...)

Shows a loaded rewarded interstitial ad and resolves when the user earns the reward.

showRewardInterstitialAd(options?: AdShowOptions | undefined) => Promise<AdMobRewardInterstitialItem>

\n\n\n

interface RewardInterstitialAdOptions

Options for loading a rewarded interstitial ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
ssvAtLeastOne<{ /** * A user identifier passed to the SSV callback. */ userId: string; /** * Custom data passed to the SSV callback. */ customData: string; }>Server-side verification options for the rewarded interstitial ad. Provide at least one of userId or customData.
adIdstringThe ad unit ID to load.1.1.2
isTestingbooleanWhether to request a test ad.false1.1.2
marginnumberThe banner margin in logical display units (dp on Android and points on iOS). For BOTTOM_CENTER, this is the bottom margin. For TOP_CENTER, this is the top margin.01.1.2
npabooleanWhether to request non-personalized ads.false1.2.0
immersiveModebooleanWhether to display a full-screen ad in immersive mode on Android.7.0.3
\n\n\n

interface AdMobRewardInterstitialItem

The reward earned by the user after viewing a rewarded interstitial ad.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
typestringThe reward item type configured for the ad unit.
amountnumberThe reward amount earned by the user.

isTestingテスト を参照してください。

\n\n\n\n

サーバーサイド検証

\n

サーバーサイド検証(SSV)は、報酬が得られたことをバックエンドで確認するための仕組みです。Google の SSV の説明 を見てください。コールバックは本番広告でのみ送られ、テスト広告では SSV エンドポイントは呼ばれません。

\n

ssv のペイロードをローカルで確認するには、RewardAdPluginEvents.Rewarded のあとにモックリクエストを送れます。ENVIRONMENT_IS_DEVELOPMENT は自分の開発用フラグに置き換えてください。

\n
const userId = 'USER_ID';\nconst customData = JSON.stringify({ placement: 'bonus' });\n\nawait AdMob.addListener(RewardAdPluginEvents.Rewarded, async () => {\n  if (!ENVIRONMENT_IS_DEVELOPMENT) {\n    return;\n  }\n  try {\n    const params = new URLSearchParams({\n      ad_network: 'TEST',\n      ad_unit: 'TEST',\n      custom_data: customData,\n      reward_amount: 'TEST',\n      reward_item: 'TEST',\n      timestamp: 'TEST',\n      transaction_id: 'TEST',\n      user_id: userId,\n      signature: 'TEST',\n      key_id: 'TEST',\n    });\n    await fetch(`https://your-staging-ssv-endpoint?${params.toString()}`);\n  } catch (err) {\n    console.error(err);\n  }\n});\n
", "headings": [ { "id": "%E3%83%AA%E3%83%AF%E3%83%BC%E3%83%89%E5%8B%95%E7%94%BB", @@ -418,7 +418,7 @@ export const PROJECT = { "file": "events.md", "section": "ガイド", "path": "/projects/capacitor-admob/docs/events", - "html": "

Google は各形式のページでライフサイクルコールバックを説明しています。例は バナーの広告イベント です。このプラグインでは下表の名前を使い、ネイティブの AdListener メソッド名は使いません。有料ペイロードは インプレッション単位の売上iOS)を見てください。

\n

最初のライフサイクルとインプレッションを取りこぼさないよう、広告のロードや表示より前にリスナーを登録します。

\n

リスナーの登録と解除

\n

AdMob.addListener はハンドルを返します。登録を await し、画面を破棄するときに remove() します。

\n
import { AdMob, BannerAdPluginEvents } from '@capacitor-community/admob';\n\nconst handle = await AdMob.addListener(BannerAdPluginEvents.Loaded, () => {\n  console.log('Banner loaded');\n});\n\nawait handle.remove();\n

method addListener(AppOpenAdPluginEvents.Loaded, ...)

Listens for App Open ad load events.

addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.FailedToLoad, ...)

Listens for App Open ad load failures.

addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.Opened, ...)

Listens for App Open ad opened events.

addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.Closed, ...)

Listens for App Open ad closed events.

addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.FailedToShow, ...)

Listens for App Open ad show failures.

addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.AdImpression, ...)

Listens for App Open impression-level ad revenue events.

addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.SizeChanged, ...)

Listens for changes to the displayed banner dimensions.

addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.Loaded, ...)

Listens for banner ad load events.

addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.FailedToLoad, ...)

Listens for banner ad load failures.

addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.Opened, ...)

Listens for banner overlay opened events.

addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.Closed, ...)

Listens for banner overlay closed events.

addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.AdImpression, ...)

Listens for banner impression events.

addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.AdPaid, ...)

Listens for banner impression-level ad revenue events.

addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.FailedToLoad, ...)

Listens for interstitial ad load failures.

addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.Loaded, ...)

Listens for interstitial ad load events.

addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.Dismissed, ...)

Listens for interstitial ad dismissed events.

addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.FailedToShow, ...)

Listens for interstitial ad show failures.

addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.Showed, ...)

Listens for interstitial ad shown events.

addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.AdImpression, ...)

Listens for interstitial impression-level ad revenue events.

addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.FailedToLoad, ...)

Listens for rewarded ad load failures.

addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Loaded, ...)

Listens for rewarded ad load events.

addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Rewarded, ...)

Listens for earned reward events.

addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Dismissed, ...)

Listens for rewarded ad dismissed events.

addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.FailedToShow, ...)

Listens for rewarded ad show failures.

addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Showed, ...)

Listens for rewarded ad shown events.

addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.AdImpression, ...)

Listens for rewarded impression-level ad revenue events.

addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)

Listens for rewarded interstitial ad load failures.

addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Loaded, ...)

Listens for rewarded interstitial ad load events.

addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)

Listens for earned reward events.

addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)

Listens for rewarded interstitial ad dismissed events.

addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)

Listens for rewarded interstitial ad show failures.

addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Showed, ...)

Listens for rewarded interstitial ad shown events.

addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)

Listens for rewarded interstitial impression-level ad revenue events.

addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

共通のライフサイクルイベント

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
イベント発行されるとき
Loaded広告のロードが完了し、表示できる状態になった。
FailedToLoad広告をロードできなかった。AdMobError を確認する。
Showed / Opened広告がユーザーに見えた。
FailedToShowロード済みの広告を表示できなかった。
Dismissed / Closedユーザーがフルスクリーン広告またはオーバーレイを閉じた。
Rewardedユーザーが案内どおりの報酬を得た。
SizeChangedバナーの寸法が変わった。
AdImpression / AdPaidインプレッションが記録された。売上イベントは下記。
\n

エラー

\n

FailedToLoadFailedToShow のリスナーは AdMobError ペイロードを受け取ります。

\n

interface AdMobError

An error returned by the Google Mobile Ads SDK.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
codenumberGets the error's code.
messagestringGets the message describing the error.
\n\n\n

インプレッション単位の売上

\n

フルスクリーン形式は AdImpressionAdMobRevenueData を出します。バナーは同じペイロードを AdPaid で出します。バナーの AdImpression にペイロードはなく、インプレッションが記録されたことだけを知らせます。

\n

interface AdMobRevenueData

Impression-level ad revenue data emitted by a paid event.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
adUnitIdstringThe ad unit ID associated with the paid event.
valueMicrosnumberThe ad value in micros, where 1,000,000 micros equals one currency unit.
currencyCodestringThe ISO 4217 currency code for valueMicros.
precisionAdValuePrecisionThe precision of the reported ad value.
networkNamestringThe mediation adapter class name that served the impression, or an empty string when unavailable.
impressionIdstringThe response identifier associated with the impression, or an empty string when unavailable.
\n\n\n

形式ごとのガイド

\n\n

enum AppOpenAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'appOpenAdLoaded'Emits when an App Open ad has loaded.
FailedToLoad'appOpenAdFailedToLoad'Emits when an App Open ad fails to load.
Opened'appOpenAdOpened'Emits when an App Open ad is shown.
Closed'appOpenAdClosed'Emits when an App Open ad is dismissed.
FailedToShow'appOpenAdFailedToShow'Emits when a loaded App Open ad fails to show.
AdImpression'appOpenAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum BannerAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
SizeChanged\"bannerAdSizeChanged\"Emits when the displayed banner size changes.
Loaded\"bannerAdLoaded\"Emits when a banner ad has loaded.
FailedToLoad\"bannerAdFailedToLoad\"Emits when a banner ad fails to load.
Opened\"bannerAdOpened\"Emits when a banner opens an overlay after the user taps it.
Closed\"bannerAdClosed\"Emits when the banner overlay is closed.
AdImpression\"bannerAdImpression\"Emits when an impression is recorded for the banner ad.
AdPaid\"bannerAdPaid\"Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum InterstitialAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'interstitialAdLoaded'Emits when an interstitial ad has loaded and is ready to show.
FailedToLoad'interstitialAdFailedToLoad'Emits when an interstitial ad fails to load.
Showed'interstitialAdShowed'Emits when an interstitial ad is shown.
FailedToShow'interstitialAdFailedToShow'Emits when a loaded interstitial ad fails to show.
Dismissed'interstitialAdDismissed'Emits when an interstitial ad is dismissed.
AdImpression'interstitialAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum RewardAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'onRewardedVideoAdLoaded'Emits when a rewarded ad has loaded and is ready to show.
FailedToLoad'onRewardedVideoAdFailedToLoad'Emits when a rewarded ad fails to load.
Showed'onRewardedVideoAdShowed'Emits when a rewarded ad is shown.
FailedToShow'onRewardedVideoAdFailedToShow'Emits when a loaded rewarded ad fails to show.
Dismissed'onRewardedVideoAdDismissed'Emits when a rewarded ad is dismissed. This event does not indicate whether the user earned a reward. Listen for Rewarded separately before granting the reward.
Rewarded'onRewardedVideoAdReward'Emits when the user earns the advertised reward.
AdImpression'onRewardedVideoAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum RewardInterstitialAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'onRewardedInterstitialAdLoaded'Emits when a rewarded interstitial ad has loaded and is ready to show.
FailedToLoad'onRewardedInterstitialAdFailedToLoad'Emits when a rewarded interstitial ad fails to load.
Showed'onRewardedInterstitialAdShowed'Emits when a rewarded interstitial ad is shown.
FailedToShow'onRewardedInterstitialAdFailedToShow'Emits when a loaded rewarded interstitial ad fails to show.
Dismissed'onRewardedInterstitialAdDismissed'Emits when a rewarded interstitial ad is dismissed. This event does not indicate whether the user earned a reward. Listen for Rewarded separately before granting the reward.
Rewarded'onRewardedInterstitialAdReward'Emits when the user earns the advertised reward.
AdImpression'onRewardedInterstitialAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n", + "html": "

Google は各形式のページでライフサイクルコールバックを説明しています。例は バナーの広告イベント です。このプラグインでは下表の名前を使い、ネイティブの AdListener メソッド名は使いません。有料ペイロードは インプレッション単位の売上iOS)を見てください。

\n

最初のライフサイクルとインプレッションを取りこぼさないよう、広告のロードや表示より前にリスナーを登録します。

\n

リスナーの登録と解除

\n

AdMob.addListener はハンドルを返します。登録を await し、画面を破棄するときに remove() します。

\n
import { AdMob, BannerAdPluginEvents } from '@capacitor-community/admob';\n\nconst handle = await AdMob.addListener(BannerAdPluginEvents.Loaded, () => {\n  console.log('Banner loaded');\n});\n\nawait handle.remove();\n

method addListener(AppOpenAdPluginEvents.Loaded, ...)

Listens for App Open ad load events.

addListener(eventName: AppOpenAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.FailedToLoad, ...)

Listens for App Open ad load failures.

addListener(eventName: AppOpenAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.Opened, ...)

Listens for App Open ad opened events.

addListener(eventName: AppOpenAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.Closed, ...)

Listens for App Open ad closed events.

addListener(eventName: AppOpenAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.FailedToShow, ...)

Listens for App Open ad show failures.

addListener(eventName: AppOpenAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(AppOpenAdPluginEvents.AdImpression, ...)

Listens for App Open impression-level ad revenue events.

addListener(eventName: AppOpenAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.SizeChanged, ...)

Listens for changes to the displayed banner dimensions.

addListener(eventName: BannerAdPluginEvents.SizeChanged, listenerFunc: (info: AdMobBannerSize) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.Loaded, ...)

Listens for banner ad load events.

addListener(eventName: BannerAdPluginEvents.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.FailedToLoad, ...)

Listens for banner ad load failures.

addListener(eventName: BannerAdPluginEvents.FailedToLoad, listenerFunc: (info: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.Opened, ...)

Listens for banner overlay opened events.

addListener(eventName: BannerAdPluginEvents.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.Closed, ...)

Listens for banner overlay closed events.

addListener(eventName: BannerAdPluginEvents.Closed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.AdImpression, ...)

Listens for banner impression events.

addListener(eventName: BannerAdPluginEvents.AdImpression, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BannerAdPluginEvents.AdPaid, ...)

Listens for banner impression-level ad revenue events.

addListener(eventName: BannerAdPluginEvents.AdPaid, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.FailedToLoad, ...)

Listens for interstitial ad load failures.

addListener(eventName: InterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.Loaded, ...)

Listens for interstitial ad load events.

addListener(eventName: InterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.Dismissed, ...)

Listens for interstitial ad dismissed events.

addListener(eventName: InterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.FailedToShow, ...)

Listens for interstitial ad show failures.

addListener(eventName: InterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.Showed, ...)

Listens for interstitial ad shown events.

addListener(eventName: InterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(InterstitialAdPluginEvents.AdImpression, ...)

Listens for interstitial impression-level ad revenue events.

addListener(eventName: InterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.FailedToLoad, ...)

Listens for rewarded ad load failures.

addListener(eventName: RewardAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Loaded, ...)

Listens for rewarded ad load events.

addListener(eventName: RewardAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Rewarded, ...)

Listens for earned reward events.

addListener(eventName: RewardAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardItem) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Dismissed, ...)

Listens for rewarded ad dismissed events.

addListener(eventName: RewardAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.FailedToShow, ...)

Listens for rewarded ad show failures.

addListener(eventName: RewardAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.Showed, ...)

Listens for rewarded ad shown events.

addListener(eventName: RewardAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardAdPluginEvents.AdImpression, ...)

Listens for rewarded impression-level ad revenue events.

addListener(eventName: RewardAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.FailedToLoad, ...)

Listens for rewarded interstitial ad load failures.

addListener(eventName: RewardInterstitialAdPluginEvents.FailedToLoad, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Loaded, ...)

Listens for rewarded interstitial ad load events.

addListener(eventName: RewardInterstitialAdPluginEvents.Loaded, listenerFunc: (info: AdLoadInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Rewarded, ...)

Listens for earned reward events.

addListener(eventName: RewardInterstitialAdPluginEvents.Rewarded, listenerFunc: (reward: AdMobRewardInterstitialItem) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Dismissed, ...)

Listens for rewarded interstitial ad dismissed events.

addListener(eventName: RewardInterstitialAdPluginEvents.Dismissed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.FailedToShow, ...)

Listens for rewarded interstitial ad show failures.

addListener(eventName: RewardInterstitialAdPluginEvents.FailedToShow, listenerFunc: (error: AdMobError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.Showed, ...)

Listens for rewarded interstitial ad shown events.

addListener(eventName: RewardInterstitialAdPluginEvents.Showed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(RewardInterstitialAdPluginEvents.AdImpression, ...)

Listens for rewarded interstitial impression-level ad revenue events.

addListener(eventName: RewardInterstitialAdPluginEvents.AdImpression, listenerFunc: (data: AdMobRevenueData) => void) => Promise<PluginListenerHandle>

\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

共通のライフサイクルイベント

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
イベント発行されるとき
Loaded広告のロードが完了し、表示できる状態になった。
FailedToLoad広告をロードできなかった。AdMobError を確認する。
Showed / Opened広告がユーザーに見えた。
FailedToShowロード済みの広告を表示できなかった。
Dismissed / Closedユーザーがフルスクリーン広告またはオーバーレイを閉じた。
Rewardedユーザーが案内どおりの報酬を得た。
SizeChangedバナーの寸法が変わった。
AdImpression / AdPaidインプレッションが記録された。売上イベントは下記。
\n

エラー

\n

FailedToLoadFailedToShow のリスナーは AdMobError ペイロードを受け取ります。

\n

interface AdMobError

An error returned by the Google Mobile Ads SDK.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
codenumberGets the error's code.
messagestringGets the message describing the error.
\n\n\n

インプレッション単位の売上

\n

フルスクリーン形式は AdImpressionAdMobRevenueData を出します。バナーは同じペイロードを AdPaid で出します。バナーの AdImpression にペイロードはなく、インプレッションが記録されたことだけを知らせます。

\n

interface AdMobRevenueData

Impression-level ad revenue data emitted by a paid event.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
adUnitIdstringThe ad unit ID associated with the paid event.
valueMicrosnumberThe ad value in micros, where 1,000,000 micros equals one currency unit.
currencyCodestringThe ISO 4217 currency code for valueMicros.
precisionAdValuePrecisionThe precision of the reported ad value.
networkNamestringThe mediation adapter class name that served the impression, or an empty string when unavailable.
impressionIdstringThe response identifier associated with the impression, or an empty string when unavailable.
\n\n\n

形式ごとのガイド

\n\n

enum AppOpenAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'appOpenAdLoaded'Emits when an App Open ad has loaded.
FailedToLoad'appOpenAdFailedToLoad'Emits when an App Open ad fails to load.
Opened'appOpenAdOpened'Emits when an App Open ad is shown.
Closed'appOpenAdClosed'Emits when an App Open ad is dismissed.
FailedToShow'appOpenAdFailedToShow'Emits when a loaded App Open ad fails to show.
AdImpression'appOpenAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum BannerAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
SizeChanged\"bannerAdSizeChanged\"Emits when the displayed banner size changes.
Loaded\"bannerAdLoaded\"Emits when a banner ad has loaded.
FailedToLoad\"bannerAdFailedToLoad\"Emits when a banner ad fails to load.
Opened\"bannerAdOpened\"Emits when a banner opens an overlay after the user taps it.
Closed\"bannerAdClosed\"Emits when the banner overlay is closed.
AdImpression\"bannerAdImpression\"Emits when an impression is recorded for the banner ad.
AdPaid\"bannerAdPaid\"Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum InterstitialAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'interstitialAdLoaded'Emits when an interstitial ad has loaded and is ready to show.
FailedToLoad'interstitialAdFailedToLoad'Emits when an interstitial ad fails to load.
Showed'interstitialAdShowed'Emits when an interstitial ad is shown.
FailedToShow'interstitialAdFailedToShow'Emits when a loaded interstitial ad fails to show.
Dismissed'interstitialAdDismissed'Emits when an interstitial ad is dismissed.
AdImpression'interstitialAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum RewardAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'onRewardedVideoAdLoaded'Emits when a rewarded ad has loaded and is ready to show.
FailedToLoad'onRewardedVideoAdFailedToLoad'Emits when a rewarded ad fails to load.
Showed'onRewardedVideoAdShowed'Emits when a rewarded ad is shown.
FailedToShow'onRewardedVideoAdFailedToShow'Emits when a loaded rewarded ad fails to show.
Dismissed'onRewardedVideoAdDismissed'Emits when a rewarded ad is dismissed. This event does not indicate whether the user earned a reward. Listen for Rewarded separately before granting the reward.
Rewarded'onRewardedVideoAdReward'Emits when the user earns the advertised reward.
AdImpression'onRewardedVideoAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n

enum RewardInterstitialAdPluginEvents

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValueDescription
Loaded'onRewardedInterstitialAdLoaded'Emits when a rewarded interstitial ad has loaded and is ready to show.
FailedToLoad'onRewardedInterstitialAdFailedToLoad'Emits when a rewarded interstitial ad fails to load.
Showed'onRewardedInterstitialAdShowed'Emits when a rewarded interstitial ad is shown.
FailedToShow'onRewardedInterstitialAdFailedToShow'Emits when a loaded rewarded interstitial ad fails to show.
Dismissed'onRewardedInterstitialAdDismissed'Emits when a rewarded interstitial ad is dismissed. This event does not indicate whether the user earned a reward. Listen for Rewarded separately before granting the reward.
Rewarded'onRewardedInterstitialAdReward'Emits when the user earns the advertised reward.
AdImpression'onRewardedInterstitialAdImpression'Emits impression-level ad revenue data when a paid event is recorded.
\n\n", "headings": [ { "id": "%E3%83%AA%E3%82%B9%E3%83%8A%E3%83%BC%E3%81%AE%E7%99%BB%E9%8C%B2%E3%81%A8%E8%A7%A3%E9%99%A4", diff --git a/projects/docs/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts index 9cbcb3f..678cc47 100644 --- a/projects/docs/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-brotherprint.ja.generated.ts @@ -178,7 +178,7 @@ export const PROJECT = { "file": "print.md", "section": "ガイド", "path": "/projects/capacitor-brotherprint/docs/print", - "html": "

printImage は base64 画像を Brother プリンターへ送ります。インストール のあとで呼び出します。プリンターの探索は Search、印刷結果は Events です。

\n
import {\n  BrotherPrint,\n  BRLMPrinterLabelName,\n  BRLMPrinterModelName,\n  BRLMPrinterPort,\n} from '@rdlabo/capacitor-brotherprint';\nimport type { BRLMPrintOptions } from '@rdlabo/capacitor-brotherprint';\n\nconst printImage = async () => {\n  const options: BRLMPrintOptions = {\n    modelName: BRLMPrinterModelName.QL_820NWB,\n    labelName: BRLMPrinterLabelName.RollW62,\n    encodedImage: 'base64 removed mime-type',\n    numberOfCopies: 1,\n    autoCut: true,\n    port: BRLMPrinterPort.wifi,\n    channelInfo: '192.168.0.10',\n  };\n\n  await BrotherPrint.printImage(options);\n};\n

portchannelInfoonPrinterAvailable の結果から取ります。完全なページはデモを見てください:

\n

https://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.tshttps://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.ts

\n

method printImage(...)

printImage(options: BRLMPrintOptions) => Promise<void>

\n\n

type alias BRLMPrintOptions

{ encodedImage: string; /** * Should use enum BRLMPrinterModelName */ modelName: BRLMPrinterModelName; } & Partial&lt;BRLMChannelResult&gt; & (BRLMPrinterQLModelSettings | BRLMPrinterTDModelSettings)

\n\n", + "html": "

printImage は base64 画像を Brother プリンターへ送ります。インストール のあとで呼び出します。プリンターの探索は Search、印刷結果は Events です。

\n
import {\n  BrotherPrint,\n  BRLMPrinterLabelName,\n  BRLMPrinterModelName,\n  BRLMPrinterPort,\n} from '@rdlabo/capacitor-brotherprint';\nimport type { BRLMPrintOptions } from '@rdlabo/capacitor-brotherprint';\n\nconst printImage = async () => {\n  const options: BRLMPrintOptions = {\n    modelName: BRLMPrinterModelName.QL_820NWB,\n    labelName: BRLMPrinterLabelName.RollW62,\n    encodedImage: 'base64 removed mime-type',\n    numberOfCopies: 1,\n    autoCut: true,\n    port: BRLMPrinterPort.wifi,\n    channelInfo: '192.168.0.10',\n  };\n\n  await BrotherPrint.printImage(options);\n};\n

portchannelInfoonPrinterAvailable の結果から取ります。完全なページはデモを見てください:

\n

https://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.tshttps://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.ts

\n

method printImage(...)

printImage(options: BRLMPrintOptions) => Promise<void>

\n\n

type alias BRLMPrintOptions

{ encodedImage: string; /** * Should use enum BRLMPrinterModelName */ modelName: BRLMPrinterModelName; } & Partial<BRLMChannelResult> & (BRLMPrinterQLModelSettings | BRLMPrinterTDModelSettings)

\n\n", "headings": [ { "id": "method-printimage(...)", @@ -202,7 +202,7 @@ export const PROJECT = { "file": "events.md", "section": "ガイド", "path": "/projects/capacitor-brotherprint/docs/events", - "html": "

見つかったプリンターと印刷結果を受け取ります。最初のイベントを取りこぼさないよう、SearchPrint より前にリスナーを登録します。

\n
import type { PluginListenerHandle } from '@capacitor/core';\nimport { BrotherPrint, BrotherPrintEventsEnum } from '@rdlabo/capacitor-brotherprint';\n\nconst handles: PluginListenerHandle[] = [];\n\nconst registerPrintListeners = async () => {\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrinterAvailable, (printer) => {\n      console.log('printer', printer.channelInfo);\n    }),\n  );\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrint, () => {\n      console.log('onPrint');\n    }),\n  );\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, (info) => {\n      console.log('onPrintFailedCommunication', info);\n    }),\n  );\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrintError, (info) => {\n      console.log('onPrintError', info);\n    }),\n  );\n};\n\nconst removePrintListeners = async () => {\n  await Promise.all(handles.map((handle) => handle.remove()));\n};\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
イベント発行されるとき
onPrinterAvailable接続できるプリンターが見つかった
onPrint印刷が成功した
onPrintFailedCommunicationプリンターに到達できなかった
onPrintError印刷が失敗した
\n

完全なページはデモを見てください:

\n

https://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.tshttps://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.ts

\n

method addListener(BrotherPrintEventsEnum.onPrinterAvailable, ...)

Find the printer that can connected to the device.

addListener(eventName: BrotherPrintEventsEnum.onPrinterAvailable, listenerFunc: (printers: BRLMChannelResult) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BrotherPrintEventsEnum.onPrint, ...)

Success Print Event

addListener(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, ...)

Failed to connect to the printer.
\nex: Bluetooth is off, Printer is off, etc.

addListener(eventName: BrotherPrintEventsEnum.onPrintFailedCommunication, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BrotherPrintEventsEnum.onPrintError, ...)

Failed to print.

addListener(eventName: BrotherPrintEventsEnum.onPrintError, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

enum BrotherPrintEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
onPrinterAvailable'onPrinterAvailable'
onPrint'onPrint'
onPrintFailedCommunication'onPrintFailedCommunication'
onPrintError'onPrintError'
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

type alias ErrorInfo

{ message: string; code: number; }

\n\n", + "html": "

見つかったプリンターと印刷結果を受け取ります。最初のイベントを取りこぼさないよう、SearchPrint より前にリスナーを登録します。

\n
import type { PluginListenerHandle } from '@capacitor/core';\nimport { BrotherPrint, BrotherPrintEventsEnum } from '@rdlabo/capacitor-brotherprint';\n\nconst handles: PluginListenerHandle[] = [];\n\nconst registerPrintListeners = async () => {\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrinterAvailable, (printer) => {\n      console.log('printer', printer.channelInfo);\n    }),\n  );\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrint, () => {\n      console.log('onPrint');\n    }),\n  );\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, (info) => {\n      console.log('onPrintFailedCommunication', info);\n    }),\n  );\n  handles.push(\n    await BrotherPrint.addListener(BrotherPrintEventsEnum.onPrintError, (info) => {\n      console.log('onPrintError', info);\n    }),\n  );\n};\n\nconst removePrintListeners = async () => {\n  await Promise.all(handles.map((handle) => handle.remove()));\n};\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
イベント発行されるとき
onPrinterAvailable接続できるプリンターが見つかった
onPrint印刷が成功した
onPrintFailedCommunicationプリンターに到達できなかった
onPrintError印刷が失敗した
\n

完全なページはデモを見てください:

\n

https://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.tshttps://github.com/rdlabo-dev/capacitor-brotherprint/blob/v8.1.1/demo/src/app/home/home.page.ts

\n

method addListener(BrotherPrintEventsEnum.onPrinterAvailable, ...)

Find the printer that can connected to the device.

addListener(eventName: BrotherPrintEventsEnum.onPrinterAvailable, listenerFunc: (printers: BRLMChannelResult) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BrotherPrintEventsEnum.onPrint, ...)

Success Print Event

addListener(eventName: BrotherPrintEventsEnum.onPrint, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BrotherPrintEventsEnum.onPrintFailedCommunication, ...)

Failed to connect to the printer.
\nex: Bluetooth is off, Printer is off, etc.

addListener(eventName: BrotherPrintEventsEnum.onPrintFailedCommunication, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(BrotherPrintEventsEnum.onPrintError, ...)

Failed to print.

addListener(eventName: BrotherPrintEventsEnum.onPrintError, listenerFunc: (info: ErrorInfo) => void) => Promise<PluginListenerHandle>

\n\n\n

enum BrotherPrintEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
onPrinterAvailable'onPrinterAvailable'
onPrint'onPrint'
onPrintFailedCommunication'onPrintFailedCommunication'
onPrintError'onPrintError'
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

type alias ErrorInfo

{ message: string; code: number; }

\n\n", "headings": [ { "id": "method-addlistener(brotherprinteventsenum.onprinteravailable%2C-...)", diff --git a/projects/docs/src/app/generated/projects/capacitor-codescanner.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-codescanner.ja.generated.ts index f65f15b..e25e3c0 100644 --- a/projects/docs/src/app/generated/projects/capacitor-codescanner.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-codescanner.ja.generated.ts @@ -75,7 +75,7 @@ export const PROJECT = { "file": "code-scanner.md", "section": "ガイド", "path": "/projects/capacitor-codescanner/docs/code-scanner", - "html": "

CodeScanner はネイティブのスキャナーモーダルを開き、スキャン結果を届けます。インストール のあとで呼び出します。最初の検出を取りこぼさないよう、present より前に addListener を登録します。

\n

present

\n
import { CodeScanner } from '@rdlabo/capacitor-codescanner';\n\nconst scanQRCode = async () => {\n  await CodeScanner.addListener('CodeScannerCatchEvent', (event) => {\n    console.log('Scanned code:', event.code);\n  });\n\n  await CodeScanner.present({\n    detectionWidth: 0.6,\n    detectionHeight: 0.15,\n    isMulti: false,\n    CodeTypes: ['qr'],\n  });\n};\n\nconst scanMultipleCodes = async () => {\n  await CodeScanner.addListener('CodeScannerCatchEvent', (event) => {\n    console.log('Scanned code:', event.code);\n  });\n\n  await CodeScanner.present({\n    detectionWidth: 0.8,\n    detectionHeight: 0.2,\n    isMulti: true,\n    CodeTypes: ['qr', 'code39', 'ean13', 'code128'],\n  });\n};\n

isMulti: true だとモーダルを開いたまま複数コードをスキャンできます。

\n

method present(...)

present(scannerOption: ScannerOption) => Promise<void>

\n\n

interface ScannerOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
detectionWidthnumber
detectionHeightnumber
enableCloseButtonbooleanEnable close button on the top left of the scanning area (default: true)
sheetScreenRationumberSpecify the ratio of the scanning area (sheet modal size) to the screen size. Default is 0.9 for android, 1(pageSheet) for iOS.
metadataObjectTypesMetadataObjectTypes[]Specify the types of codes to recognize (default: [\"qr\", \"code39\", \"ean13\"])
isMultibooleanEnable multi scan mode (default: false)
enableAutoLightbooleanEnable auto light when environment is dark (default: true)
\n\n

type alias MetadataObjectTypes

'aztec' | 'code128' | 'code39' | 'code39Mod43' | 'code93' | 'dataMatrix' | 'ean13' | 'ean8' | 'face' | 'interleaved2of5' | 'itf14' | 'pdf417' | 'qr' | 'upce' | 'catBody' | 'dogBody' | 'humanBody' | 'salientObject'

\n\n

addListener

\n
import { CodeScanner } from '@rdlabo/capacitor-codescanner';\n\nconst handle = await CodeScanner.addListener('CodeScannerCatchEvent', (event) => {\n  console.log('Scanned code:', event.code);\n});\n\nawait handle.remove();\n

method addListener('CodeScannerCatchEvent', ...)

addListener(eventName: 'CodeScannerCatchEvent', listenerFunc: (event: { code: string; }) => void) => Promise<PluginListenerHandle>

\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n", + "html": "

CodeScanner はネイティブのスキャナーモーダルを開き、スキャン結果を届けます。インストール のあとで呼び出します。最初の検出を取りこぼさないよう、present より前に addListener を登録します。

\n

present

\n
import { CodeScanner } from '@rdlabo/capacitor-codescanner';\n\nconst scanQRCode = async () => {\n  await CodeScanner.addListener('CodeScannerCatchEvent', (event) => {\n    console.log('Scanned code:', event.code);\n  });\n\n  await CodeScanner.present({\n    detectionWidth: 0.6,\n    detectionHeight: 0.15,\n    isMulti: false,\n    CodeTypes: ['qr'],\n  });\n};\n\nconst scanMultipleCodes = async () => {\n  await CodeScanner.addListener('CodeScannerCatchEvent', (event) => {\n    console.log('Scanned code:', event.code);\n  });\n\n  await CodeScanner.present({\n    detectionWidth: 0.8,\n    detectionHeight: 0.2,\n    isMulti: true,\n    CodeTypes: ['qr', 'code39', 'ean13', 'code128'],\n  });\n};\n

isMulti: true だとモーダルを開いたまま複数コードをスキャンできます。

\n

method present(...)

present(scannerOption: ScannerOption) => Promise<void>

\n\n

interface ScannerOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescription
detectionWidthnumber
detectionHeightnumber
enableCloseButtonbooleanEnable close button on the top left of the scanning area (default: true)
sheetScreenRationumberSpecify the ratio of the scanning area (sheet modal size) to the screen size. Default is 0.9 for android, 1(pageSheet) for iOS.
metadataObjectTypesMetadataObjectTypes[]Specify the types of codes to recognize (default: [\"qr\", \"code39\", \"ean13\"])
isMultibooleanEnable multi scan mode (default: false)
enableAutoLightbooleanEnable auto light when environment is dark (default: true)
\n\n

type alias MetadataObjectTypes

'aztec' | 'code128' | 'code39' | 'code39Mod43' | 'code93' | 'dataMatrix' | 'ean13' | 'ean8' | 'face' | 'interleaved2of5' | 'itf14' | 'pdf417' | 'qr' | 'upce' | 'catBody' | 'dogBody' | 'humanBody' | 'salientObject'

\n\n

addListener

\n
import { CodeScanner } from '@rdlabo/capacitor-codescanner';\n\nconst handle = await CodeScanner.addListener('CodeScannerCatchEvent', (event) => {\n  console.log('Scanned code:', event.code);\n});\n\nawait handle.remove();\n

method addListener('CodeScannerCatchEvent', ...)

addListener(eventName: 'CodeScannerCatchEvent', listenerFunc: (event: { code: string; }) => void) => Promise<PluginListenerHandle>

\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n", "headings": [ { "id": "present", diff --git a/projects/docs/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts b/projects/docs/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts index 4e3d2c2..3acfe02 100644 --- a/projects/docs/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/capacitor-screenshot-event.ja.generated.ts @@ -70,7 +70,7 @@ export const PROJECT = { "file": "screenshot-event.md", "section": "ガイド", "path": "/projects/capacitor-screenshot-event/docs/screenshot-event", - "html": "

ScreenshotEvent はスクリーンショットを監視します。インストール のあとで呼び出します。最初のスクリーンショットを取りこぼさないよう、startWatchEvent より前に addListener を登録します。

\n

addListener

\n
import { ScreenshotEvent } from '@rdlabo/capacitor-screenshot-event';\n\nconst handle = await ScreenshotEvent.addListener('userDidTakeScreenshot', () => {\n  // Notice take screenshot\n});\n\nawait handle.remove();\n

method addListener('userDidTakeScreenshot', ...)

addListener(eventName: 'userDidTakeScreenshot', listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

startWatchEvent

\n
import { ScreenshotEvent } from '@rdlabo/capacitor-screenshot-event';\n\nScreenshotEvent.addListener('userDidTakeScreenshot', () => {\n  // Notice take screenshot\n});\n\nScreenshotEvent.startWatchEvent();\n

method startWatchEvent()

startWatchEvent() => Promise<void>

\n\n

removeWatchEvent

\n
import { ScreenshotEvent } from '@rdlabo/capacitor-screenshot-event';\n\nScreenshotEvent.removeWatchEvent();\n

method removeWatchEvent()

removeWatchEvent() => Promise<void>

\n\n", + "html": "

ScreenshotEvent はスクリーンショットを監視します。インストール のあとで呼び出します。最初のスクリーンショットを取りこぼさないよう、startWatchEvent より前に addListener を登録します。

\n

addListener

\n
import { ScreenshotEvent } from '@rdlabo/capacitor-screenshot-event';\n\nconst handle = await ScreenshotEvent.addListener('userDidTakeScreenshot', () => {\n  // Notice take screenshot\n});\n\nawait handle.remove();\n

method addListener('userDidTakeScreenshot', ...)

addListener(eventName: 'userDidTakeScreenshot', listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

startWatchEvent

\n
import { ScreenshotEvent } from '@rdlabo/capacitor-screenshot-event';\n\nScreenshotEvent.addListener('userDidTakeScreenshot', () => {\n  // Notice take screenshot\n});\n\nScreenshotEvent.startWatchEvent();\n

method startWatchEvent()

startWatchEvent() => Promise<void>

\n\n

removeWatchEvent

\n
import { ScreenshotEvent } from '@rdlabo/capacitor-screenshot-event';\n\nScreenshotEvent.removeWatchEvent();\n

method removeWatchEvent()

removeWatchEvent() => Promise<void>

\n\n", "headings": [ { "id": "addlistener", diff --git a/projects/docs/src/app/generated/projects/stripe-identity.en.generated.ts b/projects/docs/src/app/generated/projects/stripe-identity.en.generated.ts index 3d10e95..34f8f20 100644 --- a/projects/docs/src/app/generated/projects/stripe-identity.en.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-identity.en.generated.ts @@ -277,7 +277,7 @@ export const PROJECT = { "file": "api.md", "section": "Reference", "path": "/projects/capacitor-stripe-identity/docs/api", - "html": "

Public methods, result types, error types, and events that @capacitor/docgen resolves from @capacitor-community/stripe-identity v8.2.1.

\n

addListener is generated for the three supported event names: Loaded, FailedToLoad, and VerificationResult. Completed, Canceled, and Failed are values of IdentityVerificationResult.result (IdentityVerificationSheetResultInterface). They are not separately supported addListener overloads.

\n

Methods

\n

method initialize(...)

Initializes Stripe Identity. Call this before create() on web.

initialize(options: InitializeIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method create(...)

Creates an Identity VerificationSheet from credentials generated by your
\nserver. Wait for this Promise or the Loaded event before present().

create(options: CreateIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method present()

Presents the VerificationSheet created by create(). Listen for
\nVerificationResult to distinguish completed, canceled, and failed flows.

present() => Promise<void>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)

Emitted when the VerificationSheet is ready to present.

addListener(eventName: IdentityVerificationSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)

Emitted when the VerificationSheet could not be created.

addListener(eventName: IdentityVerificationSheetEventsEnum.FailedToLoad, listenerFunc: (info: StripeIdentityError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.VerificationResult, ...)

Emitted when the presented verification flow finishes.

addListener(eventName: IdentityVerificationSheetEventsEnum.VerificationResult, listenerFunc: (result: IdentityVerificationResult) => void) => Promise<PluginListenerHandle>

\n\n\n

Interfaces

\n

interface InitializeIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key used by the web Identity SDK. Native platforms accept this option for API parity but initialize Identity from the verification session credentials supplied to create().5.4.0
\n\n

interface CreateIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
verificationIdstringID of the VerificationSession created by your server. Required on iOS and Android.5.0.3
ephemeralKeySecretstringEphemeral-key secret scoped to the VerificationSession. Required on iOS and Android and must be returned by your server.5.0.3
clientSecretstringClient secret of the VerificationSession. Required on web and ignored by the native Identity SDKs.5.4.0
\n\n

interface IdentityVerificationResult

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
resultIdentityVerificationSheetResultInterfaceFinal state of the presented verification flow.4.2.0
errorStripeIdentityErrorError details when result is Failed.4.2.0
\n\n

interface StripeIdentityError

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
codestringStripe error code when one is available.5.1.0
messagestringHuman-readable error message suitable for logging or display.5.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

Type aliases

\n

type alias IdentityVerificationSheetResultInterface

IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed

\n\n

Enums

\n

enum IdentityVerificationSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'identityVerificationSheetLoaded'
FailedToLoad'identityVerificationSheetFailedToLoad'
Completed'identityVerificationSheetCompleted'
Canceled'identityVerificationSheetCanceled'
Failed'identityVerificationSheetFailed'
VerificationResult'identityVerificationResult'
\n\n
", + "html": "

Public methods, result types, error types, and events that @capacitor/docgen resolves from @capacitor-community/stripe-identity v8.2.1.

\n

addListener is generated for the three supported event names: Loaded, FailedToLoad, and VerificationResult. Completed, Canceled, and Failed are values of IdentityVerificationResult.result (IdentityVerificationSheetResultInterface). They are not separately supported addListener overloads.

\n

Methods

\n

method initialize(...)

Initializes Stripe Identity. Call this before create() on web.

initialize(options: InitializeIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method create(...)

Creates an Identity VerificationSheet from credentials generated by your
\nserver. Wait for this Promise or the Loaded event before present().

create(options: CreateIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method present()

Presents the VerificationSheet created by create(). Listen for
\nVerificationResult to distinguish completed, canceled, and failed flows.

present() => Promise<void>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)

Emitted when the VerificationSheet is ready to present.

addListener(eventName: IdentityVerificationSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)

Emitted when the VerificationSheet could not be created.

addListener(eventName: IdentityVerificationSheetEventsEnum.FailedToLoad, listenerFunc: (info: StripeIdentityError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.VerificationResult, ...)

Emitted when the presented verification flow finishes.

addListener(eventName: IdentityVerificationSheetEventsEnum.VerificationResult, listenerFunc: (result: IdentityVerificationResult) => void) => Promise<PluginListenerHandle>

\n\n\n

Interfaces

\n

interface InitializeIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key used by the web Identity SDK. Native platforms accept this option for API parity but initialize Identity from the verification session credentials supplied to create().5.4.0
\n\n

interface CreateIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
verificationIdstringID of the VerificationSession created by your server. Required on iOS and Android.5.0.3
ephemeralKeySecretstringEphemeral-key secret scoped to the VerificationSession. Required on iOS and Android and must be returned by your server.5.0.3
clientSecretstringClient secret of the VerificationSession. Required on web and ignored by the native Identity SDKs.5.4.0
\n\n

interface IdentityVerificationResult

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
resultIdentityVerificationSheetResultInterfaceFinal state of the presented verification flow.4.2.0
errorStripeIdentityErrorError details when result is Failed.4.2.0
\n\n

interface StripeIdentityError

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
codestringStripe error code when one is available.5.1.0
messagestringHuman-readable error message suitable for logging or display.5.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

Type aliases

\n

type alias IdentityVerificationSheetResultInterface

IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed

\n\n

Enums

\n

enum IdentityVerificationSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'identityVerificationSheetLoaded'
FailedToLoad'identityVerificationSheetFailedToLoad'
Completed'identityVerificationSheetCompleted'
Canceled'identityVerificationSheetCanceled'
Failed'identityVerificationSheetFailed'
VerificationResult'identityVerificationResult'
\n\n
", "headings": [ { "id": "methods", diff --git a/projects/docs/src/app/generated/projects/stripe-identity.ja.generated.ts b/projects/docs/src/app/generated/projects/stripe-identity.ja.generated.ts index dc453da..648879c 100644 --- a/projects/docs/src/app/generated/projects/stripe-identity.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-identity.ja.generated.ts @@ -277,7 +277,7 @@ export const PROJECT = { "file": "api.md", "section": "リファレンス", "path": "/projects/capacitor-stripe-identity/docs/api", - "html": "

@capacitor/docgen@capacitor-community/stripe-identity v8.2.1 から解決した公開メソッド、結果型、エラー型、イベントの一覧です。

\n

addListener は、対応する3つのイベント名 LoadedFailedToLoadVerificationResult に対して生成されます。CompletedCanceledFailedIdentityVerificationResult.resultIdentityVerificationSheetResultInterface)の値であり、個別の addListener オーバーロードではありません。

\n

メソッド

\n

method initialize(...)

Initializes Stripe Identity. Call this before create() on web.

initialize(options: InitializeIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method create(...)

Creates an Identity VerificationSheet from credentials generated by your
\nserver. Wait for this Promise or the Loaded event before present().

create(options: CreateIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method present()

Presents the VerificationSheet created by create(). Listen for
\nVerificationResult to distinguish completed, canceled, and failed flows.

present() => Promise<void>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)

Emitted when the VerificationSheet is ready to present.

addListener(eventName: IdentityVerificationSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)

Emitted when the VerificationSheet could not be created.

addListener(eventName: IdentityVerificationSheetEventsEnum.FailedToLoad, listenerFunc: (info: StripeIdentityError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.VerificationResult, ...)

Emitted when the presented verification flow finishes.

addListener(eventName: IdentityVerificationSheetEventsEnum.VerificationResult, listenerFunc: (result: IdentityVerificationResult) => void) => Promise<PluginListenerHandle>

\n\n\n

インターフェース

\n

interface InitializeIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key used by the web Identity SDK. Native platforms accept this option for API parity but initialize Identity from the verification session credentials supplied to create().5.4.0
\n\n

interface CreateIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
verificationIdstringID of the VerificationSession created by your server. Required on iOS and Android.5.0.3
ephemeralKeySecretstringEphemeral-key secret scoped to the VerificationSession. Required on iOS and Android and must be returned by your server.5.0.3
clientSecretstringClient secret of the VerificationSession. Required on web and ignored by the native Identity SDKs.5.4.0
\n\n

interface IdentityVerificationResult

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
resultIdentityVerificationSheetResultInterfaceFinal state of the presented verification flow.4.2.0
errorStripeIdentityErrorError details when result is Failed.4.2.0
\n\n

interface StripeIdentityError

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
codestringStripe error code when one is available.5.1.0
messagestringHuman-readable error message suitable for logging or display.5.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

型エイリアス

\n

type alias IdentityVerificationSheetResultInterface

IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed

\n\n

列挙型

\n

enum IdentityVerificationSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'identityVerificationSheetLoaded'
FailedToLoad'identityVerificationSheetFailedToLoad'
Completed'identityVerificationSheetCompleted'
Canceled'identityVerificationSheetCanceled'
Failed'identityVerificationSheetFailed'
VerificationResult'identityVerificationResult'
\n\n
", + "html": "

@capacitor/docgen@capacitor-community/stripe-identity v8.2.1 から解決した公開メソッド、結果型、エラー型、イベントの一覧です。

\n

addListener は、対応する3つのイベント名 LoadedFailedToLoadVerificationResult に対して生成されます。CompletedCanceledFailedIdentityVerificationResult.resultIdentityVerificationSheetResultInterface)の値であり、個別の addListener オーバーロードではありません。

\n

メソッド

\n

method initialize(...)

Initializes Stripe Identity. Call this before create() on web.

initialize(options: InitializeIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method create(...)

Creates an Identity VerificationSheet from credentials generated by your
\nserver. Wait for this Promise or the Loaded event before present().

create(options: CreateIdentityVerificationSheetOption) => Promise<void>

\n\n\n

method present()

Presents the VerificationSheet created by create(). Listen for
\nVerificationResult to distinguish completed, canceled, and failed flows.

present() => Promise<void>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.Loaded, ...)

Emitted when the VerificationSheet is ready to present.

addListener(eventName: IdentityVerificationSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.FailedToLoad, ...)

Emitted when the VerificationSheet could not be created.

addListener(eventName: IdentityVerificationSheetEventsEnum.FailedToLoad, listenerFunc: (info: StripeIdentityError) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(IdentityVerificationSheetEventsEnum.VerificationResult, ...)

Emitted when the presented verification flow finishes.

addListener(eventName: IdentityVerificationSheetEventsEnum.VerificationResult, listenerFunc: (result: IdentityVerificationResult) => void) => Promise<PluginListenerHandle>

\n\n\n

インターフェース

\n

interface InitializeIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key used by the web Identity SDK. Native platforms accept this option for API parity but initialize Identity from the verification session credentials supplied to create().5.4.0
\n\n

interface CreateIdentityVerificationSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
verificationIdstringID of the VerificationSession created by your server. Required on iOS and Android.5.0.3
ephemeralKeySecretstringEphemeral-key secret scoped to the VerificationSession. Required on iOS and Android and must be returned by your server.5.0.3
clientSecretstringClient secret of the VerificationSession. Required on web and ignored by the native Identity SDKs.5.4.0
\n\n

interface IdentityVerificationResult

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
resultIdentityVerificationSheetResultInterfaceFinal state of the presented verification flow.4.2.0
errorStripeIdentityErrorError details when result is Failed.4.2.0
\n\n

interface StripeIdentityError

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
codestringStripe error code when one is available.5.1.0
messagestringHuman-readable error message suitable for logging or display.5.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

型エイリアス

\n

type alias IdentityVerificationSheetResultInterface

IdentityVerificationSheetEventsEnum.Completed | IdentityVerificationSheetEventsEnum.Canceled | IdentityVerificationSheetEventsEnum.Failed

\n\n

列挙型

\n

enum IdentityVerificationSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'identityVerificationSheetLoaded'
FailedToLoad'identityVerificationSheetFailedToLoad'
Completed'identityVerificationSheetCompleted'
Canceled'identityVerificationSheetCanceled'
Failed'identityVerificationSheetFailed'
VerificationResult'identityVerificationResult'
\n\n
", "headings": [ { "id": "%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89", diff --git a/projects/docs/src/app/generated/projects/stripe-terminal.en.generated.ts b/projects/docs/src/app/generated/projects/stripe-terminal.en.generated.ts index 3d0c685..83af8d5 100644 --- a/projects/docs/src/app/generated/projects/stripe-terminal.en.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-terminal.en.generated.ts @@ -895,7 +895,7 @@ export const PROJECT = { "file": "api.md", "section": "Reference", "path": "/projects/capacitor-stripe-terminal/docs/api", - "html": "

Reference for @capacitor-community/stripe-terminal v8.2.1. Platform support for connection types and Tap to Pay APIs is documented in Configuration.

\n

Methods

\n

method initialize(...)

Initializes the Stripe Terminal SDK and its connection-token provider.
\nCall this once before discovering readers.

When tokenProviderEndpoint is provided, the plugin sends a POST request
\nand expects { secret: string }. When it is omitted, handle
\nRequestedConnectionToken and call setConnectionToken() instead.

initialize(options: StripeTerminalInitializationOptions) => Promise<void>

\n\n\n\n

method discoverReaders(...)

Discovers readers using the requested transport. The returned readers are
\nsnapshots; listen for DiscoveredReaders when continuous discovery can
\nproduce additional results.

discoverReaders(options: DiscoverReadersOptions) => Promise<{ readers: ReaderInterface[]; }>

\n\n\n

method setConnectionToken(...)

Supplies a connection-token secret after RequestedConnectionToken is
\nemitted. Create each token on your server and use it only once.

setConnectionToken(options: SetConnectionTokenOptions) => Promise<void>

\n\n\n

method setSimulatorConfiguration(...)

Configures the simulated reader used in test mode. Call before the
\noperation whose behavior you want to simulate.

Stripe docs reference

setSimulatorConfiguration(options: SimulatorConfigurationOptions) => Promise<void>

\n\n\n\n

method connectReader(...)

Connects to a reader returned by discoverReaders().

connectReader(options: ConnectReaderOptions) => Promise<void>

\n\n\n

method getConnectedReader()

Returns the currently connected reader, or null when disconnected.

getConnectedReader() => Promise<{ reader: ReaderInterface | null; }>

\n\n\n

method disconnectReader()

Disconnects the active reader. Resolves immediately if none is connected.

disconnectReader() => Promise<void>

\n\n\n

method cancelDiscoverReaders()

Cancels the active reader-discovery operation.

cancelDiscoverReaders() => Promise<void>

\n\n\n

method collectPaymentMethod(...)

Collects a payment method for a server-created PaymentIntent. Confirm the
\ncollected intent with confirmPaymentIntent().

collectPaymentMethod(options: CollectPaymentMethodOptions) => Promise<void>

\n\n\n

method cancelCollectPaymentMethod()

Cancels an in-progress collectPaymentMethod() call.

cancelCollectPaymentMethod() => Promise<void>

\n\n\n

method confirmPaymentIntent()

Confirms the PaymentIntent most recently collected by the reader.

confirmPaymentIntent() => Promise<void>

\n\n\n

method installAvailableUpdate()

Installs the software update reported by ReportAvailableUpdate.

installAvailableUpdate() => Promise<void>

\n\n\n

method cancelInstallUpdate()

Cancels an in-progress optional reader software update.

cancelInstallUpdate() => Promise<void>

\n\n\n

method setReaderDisplay(...)

Displays cart details on a reader with a customer-facing display.

setReaderDisplay(options: Cart) => Promise<void>

\n\n\n

method clearReaderDisplay()

Clears cart details from the reader's customer-facing display.

clearReaderDisplay() => Promise<void>

\n\n\n

method rebootReader()

Reboots the connected reader. Supported reader types are platform dependent.

rebootReader() => Promise<void>

\n\n\n

method cancelReaderReconnection()

Cancels an automatic reader reconnection attempt.

cancelReaderReconnection() => Promise<void>

\n\n\n

method setTapToPayUxConfiguration(...)

Configure the Tap to Pay UX appearance (Android only).
\nCall this after initialize() but before connectReader().
\nHas no effect on iOS or web platforms.

setTapToPayUxConfiguration(options: TapToPayUxConfiguration) => Promise<void>

\n\n\n

method isTapToPayAccountLinked(...)

Check whether the merchant has accepted Apple's Tap to Pay on iPhone
\nTerms and Conditions.

iOS only, and requires iOS 16.4 or later. initialize() must have been
\ncalled first because the SDK needs a connection token provider, but no
\nreader connection is required and the call does not activate the device.

The answer is read from Apple on every call. Apple's Tap to Pay on iPhone
\nrequirements state that acceptance state must be retrieved from Apple
\nrather than from a local variable, so do not cache the result.

Stripe docs reference

isTapToPayAccountLinked(options?: IsTapToPayAccountLinkedOptions | undefined) => Promise<{ isLinked: boolean; }>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.Loaded, ...)

Emitted after the Terminal SDK has initialized.

addListener(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.RequestedConnectionToken, ...)

Emitted when the SDK needs a connection token and no token endpoint was
\nconfigured. Respond by calling setConnectionToken().

addListener(eventName: TerminalEventsEnum.RequestedConnectionToken, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DiscoveredReaders, ...)

Emitted whenever discovery produces an updated reader list. During iOS
\nBluetooth discovery this event can be emitted multiple times.

https://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetoothhttps://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetooth

addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ConnectedReader, ...)

Emitted after a reader connects successfully.

addListener(eventName: TerminalEventsEnum.ConnectedReader, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DisconnectedReader, ...)

Emitted when the reader is disconnected, either in response to disconnectReader()
\nor some connection error.

For all reader types, this is emitted in response to disconnectReader()
\nwithout a reason property.

For Bluetooth and USB readers, this is emitted with a reason property when the reader disconnects.

Note: For Bluetooth and USB readers, when you call disconnectReader(), this event
\nwill be emitted twice: one without a reason in acknowledgement of your call, and again with a reason when the reader
\nfinishes disconnecting.

addListener(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConnectionStatusChange, ...)

Emitted when the Terminal's connection status changed.

Note: You should not use this method to detect when a reader unexpectedly disconnects from your app,
\nas it cannot be used to accurately distinguish between expected and unexpected disconnect events.

To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use
\nthe UnexpectedReaderDisconnect event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)

The Terminal disconnected unexpectedly from the reader.

In your implementation of this method, you may want to notify your user that the reader disconnected.
\nYou may also call discoverReaders() to begin scanning for readers, and attempt
\nto automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it
\npossible to cancel calls to discoverReaders()

When connected to a Bluetooth or USB reader, you can get more information about the disconnect by
\nimplementing the DisconnectedReader event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)

Emitted after confirmPaymentIntent() succeeds.

addListener(eventName: TerminalEventsEnum.ConfirmedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)

Emitted after collectPaymentMethod() succeeds.

addListener(eventName: TerminalEventsEnum.CollectedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Canceled, ...)

Emitted when cancelCollectPaymentMethod() is called and succeeds.
\nThe Promise returned by cancelCollectPaymentMethod() will also be resolved.

addListener(eventName: TerminalEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Failed, ...)

Emitted when either collectPaymentMethod() or confirmPaymentIntent()
\nfails. The Promise returned by the relevant call will also be rejected.

addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: (info: { message: string; code?: string; declineCode?: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)

Emitted when a software update is available for the connected reader.

addListener(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.StartInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the connected reader begins installing a software update.
\nIf a mandatory software update is available when a reader first connects, that update is
\nautomatically installed. The update will be installed before ConnectedReader is emitted and
\nbefore the Promise returned by connectReader() resolves.
\nIn this case, you will receive this sequence of events:

    \n
  1. StartInstallingUpdate
  2. \n
  3. ReaderSoftwareUpdateProgress (repeatedly)
  4. \n
  5. FinishInstallingUpdates
  6. \n
  7. ConnectedReader
  8. \n
  9. connectReader() Promise resolves
  10. \n

Your app should show UI to the user indicating that a software update is being installed
\nto explain why connecting is taking longer than usual.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)

Only applicable to Bluetooth and USB readers.

Emitted periodically while reader software is updating to inform of the installation progress.
\nprogress is a float between 0 and 1.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when reader software installation finishes. The callback contains
\neither the installed update or an error.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.BatteryLevel, ...)

Only applicable to Bluetooth and USB readers.

Emitted upon connection and every 10 minutes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderEvent, ...)

Only applicable to Bluetooth and USB readers.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.RequestDisplayMessage, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the Terminal requests that a message be displayed in your app.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.RequestReaderInput, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the reader begins waiting for input. Your app should prompt the customer
\nto present a source using one of the given input options. If the reader emits a message,
\nthe RequestDisplayMessage event will be emitted.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.PaymentStatusChange, ...)

Emitted when the Terminal SDK's payment collection status changes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectStarted, ...)

Emitted when automatic reader reconnection begins.

addListener(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason }: { reader: ReaderInterface; reason: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectSucceeded, ...)

Emitted when automatic reader reconnection succeeds.

addListener(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectFailed, ...)

Emitted when automatic reader reconnection fails.

addListener(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

Each addListener overload is a distinct method signature. The TerminalEventsEnum table below lists member names and string values only; it does not repeat those overloads.

DiscoveringReaders and CancelDiscoveredReaders appear on the enum and are emitted by native discovery, but they have no typed overload in this list.

\n\n\n\n\n

Interfaces

\n

interface DiscoverReadersOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
typeTerminalConnectTypesDiscovery method and reader transport to use.5.1.0
locationIdstringStripe Terminal Location ID used to scope internet reader discovery and reader registration where required.5.1.0
bluetoothScanWaitTimenumberOnly applies to Bluetooth scan discovery (iOS only). During discovery, readers are reported via DiscoveryDelegate.didUpdateDiscoveredReaders. This timeout controls how long to wait before resolving the discoverReaders method with the current list. If this setting is not specified or is set to 0, the initial scan results will be returned.7.2.0
\n\n

interface TapToPayUxConfiguration

Configuration for the Tap to Pay UX (Android only).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
colorsTapToPayColorSchemeColor scheme for the Tap to Pay screen.8.1.0
darkModeTapToPayDarkModeDark-mode setting for the Tap to Pay screen.8.1.0
tapZoneTapToPayTapZonePosition of the tap indicator on screen.8.1.0
\n\n\n

interface TapToPayColorScheme

Color scheme for the Tap to Pay screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
primaryTapToPayColorPrimary color for the tap-zone indicator. Use a hex string or default.8.1.0
successTapToPayColorSuccess-state color. Use a hex string or default.8.1.0
errorTapToPayColorError-state color. Use a hex string or default.8.1.0
\n\n\n

interface IsTapToPayAccountLinkedOptions

Options for isTapToPayAccountLinked.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
onBehalfOfstringConnected account ID, for Stripe Connect platforms. Omit to check the account that owns the API key.8.2.0
\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

Type aliases

\n

interface ReaderInterface

Snapshot of a Stripe Terminal reader returned by discovery or connection.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
serialNumberstringStable hardware serial number used as the reader's primary identifier.6.2.0
labelstringHuman-readable reader label.6.2.0
batteryLevelnumberReader battery level from 0 to 1.6.2.0
batteryStatusBatteryStatusCurrent reader battery status.6.2.0
simulatedbooleanWhether this is a simulated reader.6.2.0
idnumberPlatform-specific numeric reader identifier.6.2.0
availableUpdateReaderSoftwareUpdateInterfaceAvailable reader software update, when one has been reported.6.2.0
locationIdstringStripe Terminal Location ID assigned to the reader.6.2.0
ipAddressstringReader IP address when available.6.2.0
statusNetworkStatusCurrent network status of the reader.6.2.0
locationLocationInterfaceLocation details returned with the reader, when available.6.2.0
locationStatusLocationStatusCurrent location-assignment status.6.2.0
deviceTypeDeviceTypeReader hardware type.6.2.0
deviceSoftwareVersionstring | nullInstalled reader software version, when reported by the SDK.6.2.0
isChargingnumberiOS Only properties. These properties are not available on Android.6.2.0
baseUrlstringAndroid Only properties. These properties are not available on iOS.6.2.0
bootloaderVersionstringAndroid reader bootloader version.6.2.0
configVersionstringAndroid reader configuration version.6.2.0
emvKeyProfileIdstringAndroid reader EMV key-profile identifier.6.2.0
firmwareVersionstringAndroid reader firmware version.6.2.0
hardwareVersionstringAndroid reader hardware version.6.2.0
macKeyProfileIdstringAndroid reader MAC key-profile identifier.6.2.0
pinKeyProfileIdstringAndroid reader PIN key-profile identifier.6.2.0
trackKeyProfileIdstringAndroid reader track key-profile identifier.6.2.0
settingsVersionstringAndroid reader settings version.6.2.0
pinKeysetIdstringAndroid reader PIN keyset identifier.6.2.0
\n\n\n

interface ReaderSoftwareUpdateInterface

Metadata for an available reader software update.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
deviceSoftwareVersionstringSoftware version offered by the update.6.1.0
estimatedUpdateTimeUpdateTimeEstimateEstimated duration of the update.6.1.0
requiredAtnumberUnix timestamp after which the update becomes required.6.1.0
\n\n\n

interface LocationInterface

Stripe Terminal Location assigned to a reader.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
idstringStripe Terminal Location ID.6.2.0
displayNamestringDisplay name configured for the location.6.2.0
addressLocationAddressPostal address configured for the location.6.2.0
ipAddressstringLocation IP address when provided by the SDK.6.2.0
\n\n\n

interface Cart

<a href=\"#cart\">Cart</a> totals displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
currencystringThree-letter ISO 4217 currency code.6.2.0
taxnumberTax amount in the currency's smallest unit.6.2.0
totalnumberCart total in the currency's smallest unit.6.2.0
lineItemsCartLineItem[]Items displayed in the cart.6.2.0
\n\n\n

interface CartLineItem

Line item displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
displayNamestringItem name shown on the reader.6.2.0
quantitynumberNumber of units in the cart.6.2.0
amountnumberLine-item amount in the currency's smallest unit.6.2.0
\n\n\n

type alias TapToPayColor

'default' | string

\n\n

type alias TapToPayTapZone

{ type: 'default' } | { type: 'front'; xBias: number; yBias: number } | { type: 'behind'; xBias: number; yBias: number } | { type: 'above'; bias?: number } | { type: 'below'; bias?: number } | { type: 'left'; bias?: number } | { type: 'right'; bias?: number }

TerminalResultInterface is a union of payment-result event names: TerminalEventsEnum.ConfirmedPaymentIntent, CollectedPaymentIntent, Canceled, and Failed. It is a convenience alias, not a return type of confirmPaymentIntent().

\n\n\n

Enums

\n

enum TerminalConnectTypes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Simulated'simulated'
Internet'internet'
Bluetooth'bluetooth'
Usb'usb'
TapToPay'tap-to-pay'
HandOff'hand-off'
\n\n

enum TerminalEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'terminalLoaded'
DiscoveredReaders'terminalDiscoveredReaders'
DiscoveringReaders'terminalDiscoveringReaders'
CancelDiscoveredReaders'terminalCancelDiscoveredReaders'
ConnectedReader'terminalConnectedReader'
DisconnectedReader'terminalDisconnectedReader'
ConnectionStatusChange'terminalConnectionStatusChange'
UnexpectedReaderDisconnect'terminalUnexpectedReaderDisconnect'
ConfirmedPaymentIntent'terminalConfirmedPaymentIntent'
CollectedPaymentIntent'terminalCollectedPaymentIntent'
Canceled'terminalCanceled'
Failed'terminalFailed'
RequestedConnectionToken'terminalRequestedConnectionToken'
ReportAvailableUpdate'terminalReportAvailableUpdate'
StartInstallingUpdate'terminalStartInstallingUpdate'
ReaderSoftwareUpdateProgress'terminalReaderSoftwareUpdateProgress'
FinishInstallingUpdate'terminalFinishInstallingUpdate'
BatteryLevel'terminalBatteryLevel'
ReaderEvent'terminalReaderEvent'
RequestDisplayMessage'terminalRequestDisplayMessage'
RequestReaderInput'terminalRequestReaderInput'
PaymentStatusChange'terminalPaymentStatusChange'
ReaderReconnectStarted'terminalReaderReconnectStarted'
ReaderReconnectSucceeded'terminalReaderReconnectSucceeded'
ReaderReconnectFailed'terminalReaderReconnectFailed'
\n\n

enum SimulateReaderUpdate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
UpdateAvailable'UPDATE_AVAILABLE'
None'NONE'
Required'REQUIRED'
Random'RANDOM'
LowBattery'LOW_BATTERY'
LowBatterySucceedConnect'LOW_BATTERY_SUCCEED_CONNECT'
\n\n

enum SimulatedCardType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Visa'VISA'
VisaDebit'VISA_DEBIT'
Mastercard'MASTERCARD'
MastercardDebit'MASTERCARD_DEBIT'
MastercardPrepaid'MASTERCARD_PREPAID'
Amex'AMEX'
Amex2'AMEX_2'
Discover'DISCOVER'
Discover2'DISCOVER_2'
DinersClub'DINERS'
DinersClulb14Digits'DINERS_14_DIGITS'
JCB'JCB'
UnionPay'UNION_PAY'
Interac'INTERAC'
EftposAustraliaDebit'EFTPOS_AU_DEBIT'
VisaUsCommonDebit'VISA_US_COMMON_DEBIT'
ChargeDeclined'CHARGE_DECLINED'
ChargeDeclinedInsufficientFunds'CHARGE_DECLINED_INSUFFICIENT_FUNDS'
ChargeDeclinedLostCard'CHARGE_DECLINED_LOST_CARD'
ChargeDeclinedStolenCard'CHARGE_DECLINED_STOLEN_CARD'
ChargeDeclinedExpiredCard'CHARGE_DECLINED_EXPIRED_CARD'
ChargeDeclinedProcessingError'CHARGE_DECLINED_PROCESSING_ERROR'
EftposAustraliaVisaDebit'EFTPOS_AU_VISA_DEBIT'
EftposAustraliaMastercardDebit'EFTPOS_AU_DEBIT_MASTERCARD'
OfflinePinCVM'OFFLINE_PIN_CVM'
OfflinePinSCARetry'OFFLINE_PIN_SCA_RETRY'
OnlinePinCVM'ONLINE_PIN_CVM'
OnlinePinSCARetry'ONLINE_PIN_SCA_RETRY'
\n\n

enum BatteryStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Critical'CRITICAL'
Low'LOW'
Nominal'NOMINAL'
\n\n

enum UpdateTimeEstimate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
LessThanOneMinute'LESS_THAN_ONE_MINUTE'
OneToTwoMinutes'ONE_TO_TWO_MINUTES'
TwoToFiveMinutes'TWO_TO_FIVE_MINUTES'
FiveToFifteenMinutes'FIVE_TO_FIFTEEN_MINUTES'
\n\n

enum NetworkStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Online'ONLINE'
Offline'OFFLINE'
\n\n

enum LocationStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
NotSet'NOT_SET'
Set'SET'
Unknown'UNKNOWN'
\n\n

enum DeviceType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
tapToPayDevice'tapToPayDevice'
wisePad3s'wisePad3s'
appleBuiltIn'appleBuiltIn'
chipper1X'chipper1X'
chipper2X'chipper2X'
etna'etna'
stripeM2'stripeM2'
stripeS700'stripeS700'
stripeS700DevKit'stripeS700Devkit'
wiseCube'wiseCube'
wisePad3'wisePad3'
wisePosE'wisePosE'
wisePosEDevKit'wisePosEDevkit'
unknown'unknown'
\n\n

enum DisconnectReason

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
DisconnectRequested'DISCONNECT_REQUESTED'
RebootRequested'REBOOT_REQUESTED'
SecurityReboot'SECURITY_REBOOT'
CriticallyLowBattery'CRITICALLY_LOW_BATTERY'
PoweredOff'POWERED_OFF'
BluetoothDisabled'BLUETOOTH_DISABLED'
\n\n

enum ConnectionStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotConnected'NOT_CONNECTED'
Connecting'CONNECTING'
Connected'CONNECTED'
\n\n

enum ReaderEvent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
CardInserted'CARD_INSERTED'
CardRemoved'CARD_REMOVED'
\n\n

enum ReaderDisplayMessage

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
CheckMobileDevice'CHECK_MOBILE_DEVICE'
RetryCard'RETRY_CARD'
InsertCard'INSERT_CARD'
InsertOrSwipeCard'INSERT_OR_SWIPE_CARD'
SwipeCard'SWIPE_CARD'
RemoveCard'REMOVE_CARD'
MultipleContactlessCardsDetected'MULTIPLE_CONTACTLESS_CARDS_DETECTED'
TryAnotherReadMethod'TRY_ANOTHER_READ_METHOD'
TryAnotherCard'TRY_ANOTHER_CARD'
CardRemovedTooEarly'CARD_REMOVED_TOO_EARLY'
\n\n

enum ReaderInputOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
None'NONE'
Insert'INSERT'
Swipe'SWIPE'
Tap'TAP'
ManualEntry'MANUAL_ENTRY'
\n\n

enum PaymentStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotReady'NOT_READY'
Ready'READY'
WaitingForInput'WAITING_FOR_INPUT'
Processing'PROCESSING'
\n\n

enum TapToPayDarkMode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
System'SYSTEM'
Dark'DARK'
Light'LIGHT'

DeviceGroup maps a DeviceType to a reader-image group (stripe_m2, chipper, wisepad, wisepose, s700, apple, tapToPayDevice, unknown). The enum is documented as reference-only for picking images; you do not pass it to discoverReaders or connectReader.

\n\n\n
", + "html": "

Reference for @capacitor-community/stripe-terminal v8.2.1. Platform support for connection types and Tap to Pay APIs is documented in Configuration.

\n

Methods

\n

method initialize(...)

Initializes the Stripe Terminal SDK and its connection-token provider.
\nCall this once before discovering readers.

When tokenProviderEndpoint is provided, the plugin sends a POST request
\nand expects { secret: string }. When it is omitted, handle
\nRequestedConnectionToken and call setConnectionToken() instead.

initialize(options: StripeTerminalInitializationOptions) => Promise<void>

\n\n\n\n

method discoverReaders(...)

Discovers readers using the requested transport. The returned readers are
\nsnapshots; listen for DiscoveredReaders when continuous discovery can
\nproduce additional results.

discoverReaders(options: DiscoverReadersOptions) => Promise<{ readers: ReaderInterface[]; }>

\n\n\n

method setConnectionToken(...)

Supplies a connection-token secret after RequestedConnectionToken is
\nemitted. Create each token on your server and use it only once.

setConnectionToken(options: SetConnectionTokenOptions) => Promise<void>

\n\n\n

method setSimulatorConfiguration(...)

Configures the simulated reader used in test mode. Call before the
\noperation whose behavior you want to simulate.

Stripe docs reference

setSimulatorConfiguration(options: SimulatorConfigurationOptions) => Promise<void>

\n\n\n\n

method connectReader(...)

Connects to a reader returned by discoverReaders().

connectReader(options: ConnectReaderOptions) => Promise<void>

\n\n\n

method getConnectedReader()

Returns the currently connected reader, or null when disconnected.

getConnectedReader() => Promise<{ reader: ReaderInterface | null; }>

\n\n\n

method disconnectReader()

Disconnects the active reader. Resolves immediately if none is connected.

disconnectReader() => Promise<void>

\n\n\n

method cancelDiscoverReaders()

Cancels the active reader-discovery operation.

cancelDiscoverReaders() => Promise<void>

\n\n\n

method collectPaymentMethod(...)

Collects a payment method for a server-created PaymentIntent. Confirm the
\ncollected intent with confirmPaymentIntent().

collectPaymentMethod(options: CollectPaymentMethodOptions) => Promise<void>

\n\n\n

method cancelCollectPaymentMethod()

Cancels an in-progress collectPaymentMethod() call.

cancelCollectPaymentMethod() => Promise<void>

\n\n\n

method confirmPaymentIntent()

Confirms the PaymentIntent most recently collected by the reader.

confirmPaymentIntent() => Promise<void>

\n\n\n

method installAvailableUpdate()

Installs the software update reported by ReportAvailableUpdate.

installAvailableUpdate() => Promise<void>

\n\n\n

method cancelInstallUpdate()

Cancels an in-progress optional reader software update.

cancelInstallUpdate() => Promise<void>

\n\n\n

method setReaderDisplay(...)

Displays cart details on a reader with a customer-facing display.

setReaderDisplay(options: Cart) => Promise<void>

\n\n\n

method clearReaderDisplay()

Clears cart details from the reader's customer-facing display.

clearReaderDisplay() => Promise<void>

\n\n\n

method rebootReader()

Reboots the connected reader. Supported reader types are platform dependent.

rebootReader() => Promise<void>

\n\n\n

method cancelReaderReconnection()

Cancels an automatic reader reconnection attempt.

cancelReaderReconnection() => Promise<void>

\n\n\n

method setTapToPayUxConfiguration(...)

Configure the Tap to Pay UX appearance (Android only).
\nCall this after initialize() but before connectReader().
\nHas no effect on iOS or web platforms.

setTapToPayUxConfiguration(options: TapToPayUxConfiguration) => Promise<void>

\n\n\n

method isTapToPayAccountLinked(...)

Check whether the merchant has accepted Apple's Tap to Pay on iPhone
\nTerms and Conditions.

iOS only, and requires iOS 16.4 or later. initialize() must have been
\ncalled first because the SDK needs a connection token provider, but no
\nreader connection is required and the call does not activate the device.

The answer is read from Apple on every call. Apple's Tap to Pay on iPhone
\nrequirements state that acceptance state must be retrieved from Apple
\nrather than from a local variable, so do not cache the result.

Stripe docs reference

isTapToPayAccountLinked(options?: IsTapToPayAccountLinkedOptions | undefined) => Promise<{ isLinked: boolean; }>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.Loaded, ...)

Emitted after the Terminal SDK has initialized.

addListener(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.RequestedConnectionToken, ...)

Emitted when the SDK needs a connection token and no token endpoint was
\nconfigured. Respond by calling setConnectionToken().

addListener(eventName: TerminalEventsEnum.RequestedConnectionToken, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DiscoveredReaders, ...)

Emitted whenever discovery produces an updated reader list. During iOS
\nBluetooth discovery this event can be emitted multiple times.

https://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetoothhttps://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetooth

addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ConnectedReader, ...)

Emitted after a reader connects successfully.

addListener(eventName: TerminalEventsEnum.ConnectedReader, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DisconnectedReader, ...)

Emitted when the reader is disconnected, either in response to disconnectReader()
\nor some connection error.

For all reader types, this is emitted in response to disconnectReader()
\nwithout a reason property.

For Bluetooth and USB readers, this is emitted with a reason property when the reader disconnects.

Note: For Bluetooth and USB readers, when you call disconnectReader(), this event
\nwill be emitted twice: one without a reason in acknowledgement of your call, and again with a reason when the reader
\nfinishes disconnecting.

addListener(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConnectionStatusChange, ...)

Emitted when the Terminal's connection status changed.

Note: You should not use this method to detect when a reader unexpectedly disconnects from your app,
\nas it cannot be used to accurately distinguish between expected and unexpected disconnect events.

To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use
\nthe UnexpectedReaderDisconnect event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)

The Terminal disconnected unexpectedly from the reader.

In your implementation of this method, you may want to notify your user that the reader disconnected.
\nYou may also call discoverReaders() to begin scanning for readers, and attempt
\nto automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it
\npossible to cancel calls to discoverReaders()

When connected to a Bluetooth or USB reader, you can get more information about the disconnect by
\nimplementing the DisconnectedReader event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)

Emitted after confirmPaymentIntent() succeeds.

addListener(eventName: TerminalEventsEnum.ConfirmedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)

Emitted after collectPaymentMethod() succeeds.

addListener(eventName: TerminalEventsEnum.CollectedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Canceled, ...)

Emitted when cancelCollectPaymentMethod() is called and succeeds.
\nThe Promise returned by cancelCollectPaymentMethod() will also be resolved.

addListener(eventName: TerminalEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Failed, ...)

Emitted when either collectPaymentMethod() or confirmPaymentIntent()
\nfails. The Promise returned by the relevant call will also be rejected.

addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: (info: { message: string; code?: string; declineCode?: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)

Emitted when a software update is available for the connected reader.

addListener(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.StartInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the connected reader begins installing a software update.
\nIf a mandatory software update is available when a reader first connects, that update is
\nautomatically installed. The update will be installed before ConnectedReader is emitted and
\nbefore the Promise returned by connectReader() resolves.
\nIn this case, you will receive this sequence of events:

    \n
  1. StartInstallingUpdate
  2. \n
  3. ReaderSoftwareUpdateProgress (repeatedly)
  4. \n
  5. FinishInstallingUpdates
  6. \n
  7. ConnectedReader
  8. \n
  9. connectReader() Promise resolves
  10. \n

Your app should show UI to the user indicating that a software update is being installed
\nto explain why connecting is taking longer than usual.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)

Only applicable to Bluetooth and USB readers.

Emitted periodically while reader software is updating to inform of the installation progress.
\nprogress is a float between 0 and 1.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when reader software installation finishes. The callback contains
\neither the installed update or an error.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.BatteryLevel, ...)

Only applicable to Bluetooth and USB readers.

Emitted upon connection and every 10 minutes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderEvent, ...)

Only applicable to Bluetooth and USB readers.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.RequestDisplayMessage, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the Terminal requests that a message be displayed in your app.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.RequestReaderInput, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the reader begins waiting for input. Your app should prompt the customer
\nto present a source using one of the given input options. If the reader emits a message,
\nthe RequestDisplayMessage event will be emitted.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.PaymentStatusChange, ...)

Emitted when the Terminal SDK's payment collection status changes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectStarted, ...)

Emitted when automatic reader reconnection begins.

addListener(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason }: { reader: ReaderInterface; reason: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectSucceeded, ...)

Emitted when automatic reader reconnection succeeds.

addListener(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectFailed, ...)

Emitted when automatic reader reconnection fails.

addListener(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

Each addListener overload is a distinct method signature. The TerminalEventsEnum table below lists member names and string values only; it does not repeat those overloads.

DiscoveringReaders and CancelDiscoveredReaders appear on the enum and are emitted by native discovery, but they have no typed overload in this list.

\n\n\n\n\n

Interfaces

\n

interface DiscoverReadersOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
typeTerminalConnectTypesDiscovery method and reader transport to use.5.1.0
locationIdstringStripe Terminal Location ID used to scope internet reader discovery and reader registration where required.5.1.0
bluetoothScanWaitTimenumberOnly applies to Bluetooth scan discovery (iOS only). During discovery, readers are reported via DiscoveryDelegate.didUpdateDiscoveredReaders. This timeout controls how long to wait before resolving the discoverReaders method with the current list. If this setting is not specified or is set to 0, the initial scan results will be returned.7.2.0
\n\n

interface TapToPayUxConfiguration

Configuration for the Tap to Pay UX (Android only).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
colorsTapToPayColorSchemeColor scheme for the Tap to Pay screen.8.1.0
darkModeTapToPayDarkModeDark-mode setting for the Tap to Pay screen.8.1.0
tapZoneTapToPayTapZonePosition of the tap indicator on screen.8.1.0
\n\n\n

interface TapToPayColorScheme

Color scheme for the Tap to Pay screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
primaryTapToPayColorPrimary color for the tap-zone indicator. Use a hex string or default.8.1.0
successTapToPayColorSuccess-state color. Use a hex string or default.8.1.0
errorTapToPayColorError-state color. Use a hex string or default.8.1.0
\n\n\n

interface IsTapToPayAccountLinkedOptions

Options for isTapToPayAccountLinked.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
onBehalfOfstringConnected account ID, for Stripe Connect platforms. Omit to check the account that owns the API key.8.2.0
\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

Type aliases

\n

interface ReaderInterface

Snapshot of a Stripe Terminal reader returned by discovery or connection.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
serialNumberstringStable hardware serial number used as the reader's primary identifier.6.2.0
labelstringHuman-readable reader label.6.2.0
batteryLevelnumberReader battery level from 0 to 1.6.2.0
batteryStatusBatteryStatusCurrent reader battery status.6.2.0
simulatedbooleanWhether this is a simulated reader.6.2.0
idnumberPlatform-specific numeric reader identifier.6.2.0
availableUpdateReaderSoftwareUpdateInterfaceAvailable reader software update, when one has been reported.6.2.0
locationIdstringStripe Terminal Location ID assigned to the reader.6.2.0
ipAddressstringReader IP address when available.6.2.0
statusNetworkStatusCurrent network status of the reader.6.2.0
locationLocationInterfaceLocation details returned with the reader, when available.6.2.0
locationStatusLocationStatusCurrent location-assignment status.6.2.0
deviceTypeDeviceTypeReader hardware type.6.2.0
deviceSoftwareVersionstring | nullInstalled reader software version, when reported by the SDK.6.2.0
isChargingnumberiOS Only properties. These properties are not available on Android.6.2.0
baseUrlstringAndroid Only properties. These properties are not available on iOS.6.2.0
bootloaderVersionstringAndroid reader bootloader version.6.2.0
configVersionstringAndroid reader configuration version.6.2.0
emvKeyProfileIdstringAndroid reader EMV key-profile identifier.6.2.0
firmwareVersionstringAndroid reader firmware version.6.2.0
hardwareVersionstringAndroid reader hardware version.6.2.0
macKeyProfileIdstringAndroid reader MAC key-profile identifier.6.2.0
pinKeyProfileIdstringAndroid reader PIN key-profile identifier.6.2.0
trackKeyProfileIdstringAndroid reader track key-profile identifier.6.2.0
settingsVersionstringAndroid reader settings version.6.2.0
pinKeysetIdstringAndroid reader PIN keyset identifier.6.2.0
\n\n\n

interface ReaderSoftwareUpdateInterface

Metadata for an available reader software update.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
deviceSoftwareVersionstringSoftware version offered by the update.6.1.0
estimatedUpdateTimeUpdateTimeEstimateEstimated duration of the update.6.1.0
requiredAtnumberUnix timestamp after which the update becomes required.6.1.0
\n\n\n

interface LocationInterface

Stripe Terminal Location assigned to a reader.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
idstringStripe Terminal Location ID.6.2.0
displayNamestringDisplay name configured for the location.6.2.0
addressLocationAddressPostal address configured for the location.6.2.0
ipAddressstringLocation IP address when provided by the SDK.6.2.0
\n\n\n

interface Cart

<a href=\"#cart\">Cart</a> totals displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
currencystringThree-letter ISO 4217 currency code.6.2.0
taxnumberTax amount in the currency's smallest unit.6.2.0
totalnumberCart total in the currency's smallest unit.6.2.0
lineItemsCartLineItem[]Items displayed in the cart.6.2.0
\n\n\n

interface CartLineItem

Line item displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
displayNamestringItem name shown on the reader.6.2.0
quantitynumberNumber of units in the cart.6.2.0
amountnumberLine-item amount in the currency's smallest unit.6.2.0
\n\n\n

type alias TapToPayColor

'default' | string

\n\n

type alias TapToPayTapZone

{ type: 'default' } | { type: 'front'; xBias: number; yBias: number } | { type: 'behind'; xBias: number; yBias: number } | { type: 'above'; bias?: number } | { type: 'below'; bias?: number } | { type: 'left'; bias?: number } | { type: 'right'; bias?: number }

TerminalResultInterface is a union of payment-result event names: TerminalEventsEnum.ConfirmedPaymentIntent, CollectedPaymentIntent, Canceled, and Failed. It is a convenience alias, not a return type of confirmPaymentIntent().

\n\n\n

Enums

\n

enum TerminalConnectTypes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Simulated'simulated'
Internet'internet'
Bluetooth'bluetooth'
Usb'usb'
TapToPay'tap-to-pay'
HandOff'hand-off'
\n\n

enum TerminalEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'terminalLoaded'
DiscoveredReaders'terminalDiscoveredReaders'
DiscoveringReaders'terminalDiscoveringReaders'
CancelDiscoveredReaders'terminalCancelDiscoveredReaders'
ConnectedReader'terminalConnectedReader'
DisconnectedReader'terminalDisconnectedReader'
ConnectionStatusChange'terminalConnectionStatusChange'
UnexpectedReaderDisconnect'terminalUnexpectedReaderDisconnect'
ConfirmedPaymentIntent'terminalConfirmedPaymentIntent'
CollectedPaymentIntent'terminalCollectedPaymentIntent'
Canceled'terminalCanceled'
Failed'terminalFailed'
RequestedConnectionToken'terminalRequestedConnectionToken'
ReportAvailableUpdate'terminalReportAvailableUpdate'
StartInstallingUpdate'terminalStartInstallingUpdate'
ReaderSoftwareUpdateProgress'terminalReaderSoftwareUpdateProgress'
FinishInstallingUpdate'terminalFinishInstallingUpdate'
BatteryLevel'terminalBatteryLevel'
ReaderEvent'terminalReaderEvent'
RequestDisplayMessage'terminalRequestDisplayMessage'
RequestReaderInput'terminalRequestReaderInput'
PaymentStatusChange'terminalPaymentStatusChange'
ReaderReconnectStarted'terminalReaderReconnectStarted'
ReaderReconnectSucceeded'terminalReaderReconnectSucceeded'
ReaderReconnectFailed'terminalReaderReconnectFailed'
\n\n

enum SimulateReaderUpdate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
UpdateAvailable'UPDATE_AVAILABLE'
None'NONE'
Required'REQUIRED'
Random'RANDOM'
LowBattery'LOW_BATTERY'
LowBatterySucceedConnect'LOW_BATTERY_SUCCEED_CONNECT'
\n\n

enum SimulatedCardType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Visa'VISA'
VisaDebit'VISA_DEBIT'
Mastercard'MASTERCARD'
MastercardDebit'MASTERCARD_DEBIT'
MastercardPrepaid'MASTERCARD_PREPAID'
Amex'AMEX'
Amex2'AMEX_2'
Discover'DISCOVER'
Discover2'DISCOVER_2'
DinersClub'DINERS'
DinersClulb14Digits'DINERS_14_DIGITS'
JCB'JCB'
UnionPay'UNION_PAY'
Interac'INTERAC'
EftposAustraliaDebit'EFTPOS_AU_DEBIT'
VisaUsCommonDebit'VISA_US_COMMON_DEBIT'
ChargeDeclined'CHARGE_DECLINED'
ChargeDeclinedInsufficientFunds'CHARGE_DECLINED_INSUFFICIENT_FUNDS'
ChargeDeclinedLostCard'CHARGE_DECLINED_LOST_CARD'
ChargeDeclinedStolenCard'CHARGE_DECLINED_STOLEN_CARD'
ChargeDeclinedExpiredCard'CHARGE_DECLINED_EXPIRED_CARD'
ChargeDeclinedProcessingError'CHARGE_DECLINED_PROCESSING_ERROR'
EftposAustraliaVisaDebit'EFTPOS_AU_VISA_DEBIT'
EftposAustraliaMastercardDebit'EFTPOS_AU_DEBIT_MASTERCARD'
OfflinePinCVM'OFFLINE_PIN_CVM'
OfflinePinSCARetry'OFFLINE_PIN_SCA_RETRY'
OnlinePinCVM'ONLINE_PIN_CVM'
OnlinePinSCARetry'ONLINE_PIN_SCA_RETRY'
\n\n

enum BatteryStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Critical'CRITICAL'
Low'LOW'
Nominal'NOMINAL'
\n\n

enum UpdateTimeEstimate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
LessThanOneMinute'LESS_THAN_ONE_MINUTE'
OneToTwoMinutes'ONE_TO_TWO_MINUTES'
TwoToFiveMinutes'TWO_TO_FIVE_MINUTES'
FiveToFifteenMinutes'FIVE_TO_FIFTEEN_MINUTES'
\n\n

enum NetworkStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Online'ONLINE'
Offline'OFFLINE'
\n\n

enum LocationStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
NotSet'NOT_SET'
Set'SET'
Unknown'UNKNOWN'
\n\n

enum DeviceType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
tapToPayDevice'tapToPayDevice'
wisePad3s'wisePad3s'
appleBuiltIn'appleBuiltIn'
chipper1X'chipper1X'
chipper2X'chipper2X'
etna'etna'
stripeM2'stripeM2'
stripeS700'stripeS700'
stripeS700DevKit'stripeS700Devkit'
wiseCube'wiseCube'
wisePad3'wisePad3'
wisePosE'wisePosE'
wisePosEDevKit'wisePosEDevkit'
unknown'unknown'
\n\n

enum DisconnectReason

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
DisconnectRequested'DISCONNECT_REQUESTED'
RebootRequested'REBOOT_REQUESTED'
SecurityReboot'SECURITY_REBOOT'
CriticallyLowBattery'CRITICALLY_LOW_BATTERY'
PoweredOff'POWERED_OFF'
BluetoothDisabled'BLUETOOTH_DISABLED'
\n\n

enum ConnectionStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotConnected'NOT_CONNECTED'
Connecting'CONNECTING'
Connected'CONNECTED'
\n\n

enum ReaderEvent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
CardInserted'CARD_INSERTED'
CardRemoved'CARD_REMOVED'
\n\n

enum ReaderDisplayMessage

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
CheckMobileDevice'CHECK_MOBILE_DEVICE'
RetryCard'RETRY_CARD'
InsertCard'INSERT_CARD'
InsertOrSwipeCard'INSERT_OR_SWIPE_CARD'
SwipeCard'SWIPE_CARD'
RemoveCard'REMOVE_CARD'
MultipleContactlessCardsDetected'MULTIPLE_CONTACTLESS_CARDS_DETECTED'
TryAnotherReadMethod'TRY_ANOTHER_READ_METHOD'
TryAnotherCard'TRY_ANOTHER_CARD'
CardRemovedTooEarly'CARD_REMOVED_TOO_EARLY'
\n\n

enum ReaderInputOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
None'NONE'
Insert'INSERT'
Swipe'SWIPE'
Tap'TAP'
ManualEntry'MANUAL_ENTRY'
\n\n

enum PaymentStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotReady'NOT_READY'
Ready'READY'
WaitingForInput'WAITING_FOR_INPUT'
Processing'PROCESSING'
\n\n

enum TapToPayDarkMode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
System'SYSTEM'
Dark'DARK'
Light'LIGHT'

DeviceGroup maps a DeviceType to a reader-image group (stripe_m2, chipper, wisepad, wisepose, s700, apple, tapToPayDevice, unknown). The enum is documented as reference-only for picking images; you do not pass it to discoverReaders or connectReader.

\n\n\n
", "headings": [ { "id": "methods", diff --git a/projects/docs/src/app/generated/projects/stripe-terminal.ja.generated.ts b/projects/docs/src/app/generated/projects/stripe-terminal.ja.generated.ts index d25887d..ea19fbb 100644 --- a/projects/docs/src/app/generated/projects/stripe-terminal.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe-terminal.ja.generated.ts @@ -895,7 +895,7 @@ export const PROJECT = { "file": "api.md", "section": "リファレンス", "path": "/projects/capacitor-stripe-terminal/docs/api", - "html": "

@capacitor-community/stripe-terminal v8.2.1 のリファレンスです。接続方式と Tap to Pay API の対応状況は設定を参照してください。

\n

メソッド

\n

method initialize(...)

Initializes the Stripe Terminal SDK and its connection-token provider.
\nCall this once before discovering readers.

When tokenProviderEndpoint is provided, the plugin sends a POST request
\nand expects { secret: string }. When it is omitted, handle
\nRequestedConnectionToken and call setConnectionToken() instead.

initialize(options: StripeTerminalInitializationOptions) => Promise<void>

\n\n\n\n

method discoverReaders(...)

Discovers readers using the requested transport. The returned readers are
\nsnapshots; listen for DiscoveredReaders when continuous discovery can
\nproduce additional results.

discoverReaders(options: DiscoverReadersOptions) => Promise<{ readers: ReaderInterface[]; }>

\n\n\n

method setConnectionToken(...)

Supplies a connection-token secret after RequestedConnectionToken is
\nemitted. Create each token on your server and use it only once.

setConnectionToken(options: SetConnectionTokenOptions) => Promise<void>

\n\n\n

method setSimulatorConfiguration(...)

Configures the simulated reader used in test mode. Call before the
\noperation whose behavior you want to simulate.

Stripe docs reference

setSimulatorConfiguration(options: SimulatorConfigurationOptions) => Promise<void>

\n\n\n\n

method connectReader(...)

Connects to a reader returned by discoverReaders().

connectReader(options: ConnectReaderOptions) => Promise<void>

\n\n\n

method getConnectedReader()

Returns the currently connected reader, or null when disconnected.

getConnectedReader() => Promise<{ reader: ReaderInterface | null; }>

\n\n\n

method disconnectReader()

Disconnects the active reader. Resolves immediately if none is connected.

disconnectReader() => Promise<void>

\n\n\n

method cancelDiscoverReaders()

Cancels the active reader-discovery operation.

cancelDiscoverReaders() => Promise<void>

\n\n\n

method collectPaymentMethod(...)

Collects a payment method for a server-created PaymentIntent. Confirm the
\ncollected intent with confirmPaymentIntent().

collectPaymentMethod(options: CollectPaymentMethodOptions) => Promise<void>

\n\n\n

method cancelCollectPaymentMethod()

Cancels an in-progress collectPaymentMethod() call.

cancelCollectPaymentMethod() => Promise<void>

\n\n\n

method confirmPaymentIntent()

Confirms the PaymentIntent most recently collected by the reader.

confirmPaymentIntent() => Promise<void>

\n\n\n

method installAvailableUpdate()

Installs the software update reported by ReportAvailableUpdate.

installAvailableUpdate() => Promise<void>

\n\n\n

method cancelInstallUpdate()

Cancels an in-progress optional reader software update.

cancelInstallUpdate() => Promise<void>

\n\n\n

method setReaderDisplay(...)

Displays cart details on a reader with a customer-facing display.

setReaderDisplay(options: Cart) => Promise<void>

\n\n\n

method clearReaderDisplay()

Clears cart details from the reader's customer-facing display.

clearReaderDisplay() => Promise<void>

\n\n\n

method rebootReader()

Reboots the connected reader. Supported reader types are platform dependent.

rebootReader() => Promise<void>

\n\n\n

method cancelReaderReconnection()

Cancels an automatic reader reconnection attempt.

cancelReaderReconnection() => Promise<void>

\n\n\n

method setTapToPayUxConfiguration(...)

Configure the Tap to Pay UX appearance (Android only).
\nCall this after initialize() but before connectReader().
\nHas no effect on iOS or web platforms.

setTapToPayUxConfiguration(options: TapToPayUxConfiguration) => Promise<void>

\n\n\n

method isTapToPayAccountLinked(...)

Check whether the merchant has accepted Apple's Tap to Pay on iPhone
\nTerms and Conditions.

iOS only, and requires iOS 16.4 or later. initialize() must have been
\ncalled first because the SDK needs a connection token provider, but no
\nreader connection is required and the call does not activate the device.

The answer is read from Apple on every call. Apple's Tap to Pay on iPhone
\nrequirements state that acceptance state must be retrieved from Apple
\nrather than from a local variable, so do not cache the result.

Stripe docs reference

isTapToPayAccountLinked(options?: IsTapToPayAccountLinkedOptions | undefined) => Promise<{ isLinked: boolean; }>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.Loaded, ...)

Emitted after the Terminal SDK has initialized.

addListener(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.RequestedConnectionToken, ...)

Emitted when the SDK needs a connection token and no token endpoint was
\nconfigured. Respond by calling setConnectionToken().

addListener(eventName: TerminalEventsEnum.RequestedConnectionToken, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DiscoveredReaders, ...)

Emitted whenever discovery produces an updated reader list. During iOS
\nBluetooth discovery this event can be emitted multiple times.

https://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetoothhttps://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetooth

addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ConnectedReader, ...)

Emitted after a reader connects successfully.

addListener(eventName: TerminalEventsEnum.ConnectedReader, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DisconnectedReader, ...)

Emitted when the reader is disconnected, either in response to disconnectReader()
\nor some connection error.

For all reader types, this is emitted in response to disconnectReader()
\nwithout a reason property.

For Bluetooth and USB readers, this is emitted with a reason property when the reader disconnects.

Note: For Bluetooth and USB readers, when you call disconnectReader(), this event
\nwill be emitted twice: one without a reason in acknowledgement of your call, and again with a reason when the reader
\nfinishes disconnecting.

addListener(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConnectionStatusChange, ...)

Emitted when the Terminal's connection status changed.

Note: You should not use this method to detect when a reader unexpectedly disconnects from your app,
\nas it cannot be used to accurately distinguish between expected and unexpected disconnect events.

To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use
\nthe UnexpectedReaderDisconnect event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)

The Terminal disconnected unexpectedly from the reader.

In your implementation of this method, you may want to notify your user that the reader disconnected.
\nYou may also call discoverReaders() to begin scanning for readers, and attempt
\nto automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it
\npossible to cancel calls to discoverReaders()

When connected to a Bluetooth or USB reader, you can get more information about the disconnect by
\nimplementing the DisconnectedReader event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)

Emitted after confirmPaymentIntent() succeeds.

addListener(eventName: TerminalEventsEnum.ConfirmedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)

Emitted after collectPaymentMethod() succeeds.

addListener(eventName: TerminalEventsEnum.CollectedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Canceled, ...)

Emitted when cancelCollectPaymentMethod() is called and succeeds.
\nThe Promise returned by cancelCollectPaymentMethod() will also be resolved.

addListener(eventName: TerminalEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Failed, ...)

Emitted when either collectPaymentMethod() or confirmPaymentIntent()
\nfails. The Promise returned by the relevant call will also be rejected.

addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: (info: { message: string; code?: string; declineCode?: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)

Emitted when a software update is available for the connected reader.

addListener(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.StartInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the connected reader begins installing a software update.
\nIf a mandatory software update is available when a reader first connects, that update is
\nautomatically installed. The update will be installed before ConnectedReader is emitted and
\nbefore the Promise returned by connectReader() resolves.
\nIn this case, you will receive this sequence of events:

    \n
  1. StartInstallingUpdate
  2. \n
  3. ReaderSoftwareUpdateProgress (repeatedly)
  4. \n
  5. FinishInstallingUpdates
  6. \n
  7. ConnectedReader
  8. \n
  9. connectReader() Promise resolves
  10. \n

Your app should show UI to the user indicating that a software update is being installed
\nto explain why connecting is taking longer than usual.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)

Only applicable to Bluetooth and USB readers.

Emitted periodically while reader software is updating to inform of the installation progress.
\nprogress is a float between 0 and 1.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when reader software installation finishes. The callback contains
\neither the installed update or an error.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.BatteryLevel, ...)

Only applicable to Bluetooth and USB readers.

Emitted upon connection and every 10 minutes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderEvent, ...)

Only applicable to Bluetooth and USB readers.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.RequestDisplayMessage, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the Terminal requests that a message be displayed in your app.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.RequestReaderInput, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the reader begins waiting for input. Your app should prompt the customer
\nto present a source using one of the given input options. If the reader emits a message,
\nthe RequestDisplayMessage event will be emitted.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.PaymentStatusChange, ...)

Emitted when the Terminal SDK's payment collection status changes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectStarted, ...)

Emitted when automatic reader reconnection begins.

addListener(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason }: { reader: ReaderInterface; reason: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectSucceeded, ...)

Emitted when automatic reader reconnection succeeds.

addListener(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectFailed, ...)

Emitted when automatic reader reconnection fails.

addListener(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

addListener オーバーロードは個別のメソッドシグネチャです。下の TerminalEventsEnum 表はメンバー名と文字列値だけを示し、オーバーロードは繰り返しません。

DiscoveringReadersCancelDiscoveredReaders は列挙型に含まれ、ネイティブの探索処理から送出されますが、この一覧に型付きオーバーロードはありません。

\n\n\n\n\n

インターフェース

\n

interface DiscoverReadersOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
typeTerminalConnectTypesDiscovery method and reader transport to use.5.1.0
locationIdstringStripe Terminal Location ID used to scope internet reader discovery and reader registration where required.5.1.0
bluetoothScanWaitTimenumberOnly applies to Bluetooth scan discovery (iOS only). During discovery, readers are reported via DiscoveryDelegate.didUpdateDiscoveredReaders. This timeout controls how long to wait before resolving the discoverReaders method with the current list. If this setting is not specified or is set to 0, the initial scan results will be returned.7.2.0
\n\n

interface TapToPayUxConfiguration

Configuration for the Tap to Pay UX (Android only).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
colorsTapToPayColorSchemeColor scheme for the Tap to Pay screen.8.1.0
darkModeTapToPayDarkModeDark-mode setting for the Tap to Pay screen.8.1.0
tapZoneTapToPayTapZonePosition of the tap indicator on screen.8.1.0
\n\n\n

interface TapToPayColorScheme

Color scheme for the Tap to Pay screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
primaryTapToPayColorPrimary color for the tap-zone indicator. Use a hex string or default.8.1.0
successTapToPayColorSuccess-state color. Use a hex string or default.8.1.0
errorTapToPayColorError-state color. Use a hex string or default.8.1.0
\n\n\n

interface IsTapToPayAccountLinkedOptions

Options for isTapToPayAccountLinked.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
onBehalfOfstringConnected account ID, for Stripe Connect platforms. Omit to check the account that owns the API key.8.2.0
\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

型エイリアス

\n

interface ReaderInterface

Snapshot of a Stripe Terminal reader returned by discovery or connection.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
serialNumberstringStable hardware serial number used as the reader's primary identifier.6.2.0
labelstringHuman-readable reader label.6.2.0
batteryLevelnumberReader battery level from 0 to 1.6.2.0
batteryStatusBatteryStatusCurrent reader battery status.6.2.0
simulatedbooleanWhether this is a simulated reader.6.2.0
idnumberPlatform-specific numeric reader identifier.6.2.0
availableUpdateReaderSoftwareUpdateInterfaceAvailable reader software update, when one has been reported.6.2.0
locationIdstringStripe Terminal Location ID assigned to the reader.6.2.0
ipAddressstringReader IP address when available.6.2.0
statusNetworkStatusCurrent network status of the reader.6.2.0
locationLocationInterfaceLocation details returned with the reader, when available.6.2.0
locationStatusLocationStatusCurrent location-assignment status.6.2.0
deviceTypeDeviceTypeReader hardware type.6.2.0
deviceSoftwareVersionstring | nullInstalled reader software version, when reported by the SDK.6.2.0
isChargingnumberiOS Only properties. These properties are not available on Android.6.2.0
baseUrlstringAndroid Only properties. These properties are not available on iOS.6.2.0
bootloaderVersionstringAndroid reader bootloader version.6.2.0
configVersionstringAndroid reader configuration version.6.2.0
emvKeyProfileIdstringAndroid reader EMV key-profile identifier.6.2.0
firmwareVersionstringAndroid reader firmware version.6.2.0
hardwareVersionstringAndroid reader hardware version.6.2.0
macKeyProfileIdstringAndroid reader MAC key-profile identifier.6.2.0
pinKeyProfileIdstringAndroid reader PIN key-profile identifier.6.2.0
trackKeyProfileIdstringAndroid reader track key-profile identifier.6.2.0
settingsVersionstringAndroid reader settings version.6.2.0
pinKeysetIdstringAndroid reader PIN keyset identifier.6.2.0
\n\n\n

interface ReaderSoftwareUpdateInterface

Metadata for an available reader software update.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
deviceSoftwareVersionstringSoftware version offered by the update.6.1.0
estimatedUpdateTimeUpdateTimeEstimateEstimated duration of the update.6.1.0
requiredAtnumberUnix timestamp after which the update becomes required.6.1.0
\n\n\n

interface LocationInterface

Stripe Terminal Location assigned to a reader.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
idstringStripe Terminal Location ID.6.2.0
displayNamestringDisplay name configured for the location.6.2.0
addressLocationAddressPostal address configured for the location.6.2.0
ipAddressstringLocation IP address when provided by the SDK.6.2.0
\n\n\n

interface Cart

<a href=\"#cart\">Cart</a> totals displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
currencystringThree-letter ISO 4217 currency code.6.2.0
taxnumberTax amount in the currency's smallest unit.6.2.0
totalnumberCart total in the currency's smallest unit.6.2.0
lineItemsCartLineItem[]Items displayed in the cart.6.2.0
\n\n\n

interface CartLineItem

Line item displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
displayNamestringItem name shown on the reader.6.2.0
quantitynumberNumber of units in the cart.6.2.0
amountnumberLine-item amount in the currency's smallest unit.6.2.0
\n\n\n

type alias TapToPayColor

'default' | string

\n\n

type alias TapToPayTapZone

{ type: 'default' } | { type: 'front'; xBias: number; yBias: number } | { type: 'behind'; xBias: number; yBias: number } | { type: 'above'; bias?: number } | { type: 'below'; bias?: number } | { type: 'left'; bias?: number } | { type: 'right'; bias?: number }

TerminalResultInterface は支払い結果イベント ConfirmedPaymentIntentCollectedPaymentIntentCanceledFailed の共用体です。confirmPaymentIntent() の戻り値ではなく、利便性のための別名です。

\n\n\n

列挙型

\n

enum TerminalConnectTypes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Simulated'simulated'
Internet'internet'
Bluetooth'bluetooth'
Usb'usb'
TapToPay'tap-to-pay'
HandOff'hand-off'
\n\n

enum TerminalEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'terminalLoaded'
DiscoveredReaders'terminalDiscoveredReaders'
DiscoveringReaders'terminalDiscoveringReaders'
CancelDiscoveredReaders'terminalCancelDiscoveredReaders'
ConnectedReader'terminalConnectedReader'
DisconnectedReader'terminalDisconnectedReader'
ConnectionStatusChange'terminalConnectionStatusChange'
UnexpectedReaderDisconnect'terminalUnexpectedReaderDisconnect'
ConfirmedPaymentIntent'terminalConfirmedPaymentIntent'
CollectedPaymentIntent'terminalCollectedPaymentIntent'
Canceled'terminalCanceled'
Failed'terminalFailed'
RequestedConnectionToken'terminalRequestedConnectionToken'
ReportAvailableUpdate'terminalReportAvailableUpdate'
StartInstallingUpdate'terminalStartInstallingUpdate'
ReaderSoftwareUpdateProgress'terminalReaderSoftwareUpdateProgress'
FinishInstallingUpdate'terminalFinishInstallingUpdate'
BatteryLevel'terminalBatteryLevel'
ReaderEvent'terminalReaderEvent'
RequestDisplayMessage'terminalRequestDisplayMessage'
RequestReaderInput'terminalRequestReaderInput'
PaymentStatusChange'terminalPaymentStatusChange'
ReaderReconnectStarted'terminalReaderReconnectStarted'
ReaderReconnectSucceeded'terminalReaderReconnectSucceeded'
ReaderReconnectFailed'terminalReaderReconnectFailed'
\n\n

enum SimulateReaderUpdate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
UpdateAvailable'UPDATE_AVAILABLE'
None'NONE'
Required'REQUIRED'
Random'RANDOM'
LowBattery'LOW_BATTERY'
LowBatterySucceedConnect'LOW_BATTERY_SUCCEED_CONNECT'
\n\n

enum SimulatedCardType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Visa'VISA'
VisaDebit'VISA_DEBIT'
Mastercard'MASTERCARD'
MastercardDebit'MASTERCARD_DEBIT'
MastercardPrepaid'MASTERCARD_PREPAID'
Amex'AMEX'
Amex2'AMEX_2'
Discover'DISCOVER'
Discover2'DISCOVER_2'
DinersClub'DINERS'
DinersClulb14Digits'DINERS_14_DIGITS'
JCB'JCB'
UnionPay'UNION_PAY'
Interac'INTERAC'
EftposAustraliaDebit'EFTPOS_AU_DEBIT'
VisaUsCommonDebit'VISA_US_COMMON_DEBIT'
ChargeDeclined'CHARGE_DECLINED'
ChargeDeclinedInsufficientFunds'CHARGE_DECLINED_INSUFFICIENT_FUNDS'
ChargeDeclinedLostCard'CHARGE_DECLINED_LOST_CARD'
ChargeDeclinedStolenCard'CHARGE_DECLINED_STOLEN_CARD'
ChargeDeclinedExpiredCard'CHARGE_DECLINED_EXPIRED_CARD'
ChargeDeclinedProcessingError'CHARGE_DECLINED_PROCESSING_ERROR'
EftposAustraliaVisaDebit'EFTPOS_AU_VISA_DEBIT'
EftposAustraliaMastercardDebit'EFTPOS_AU_DEBIT_MASTERCARD'
OfflinePinCVM'OFFLINE_PIN_CVM'
OfflinePinSCARetry'OFFLINE_PIN_SCA_RETRY'
OnlinePinCVM'ONLINE_PIN_CVM'
OnlinePinSCARetry'ONLINE_PIN_SCA_RETRY'
\n\n

enum BatteryStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Critical'CRITICAL'
Low'LOW'
Nominal'NOMINAL'
\n\n

enum UpdateTimeEstimate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
LessThanOneMinute'LESS_THAN_ONE_MINUTE'
OneToTwoMinutes'ONE_TO_TWO_MINUTES'
TwoToFiveMinutes'TWO_TO_FIVE_MINUTES'
FiveToFifteenMinutes'FIVE_TO_FIFTEEN_MINUTES'
\n\n

enum NetworkStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Online'ONLINE'
Offline'OFFLINE'
\n\n

enum LocationStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
NotSet'NOT_SET'
Set'SET'
Unknown'UNKNOWN'
\n\n

enum DeviceType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
tapToPayDevice'tapToPayDevice'
wisePad3s'wisePad3s'
appleBuiltIn'appleBuiltIn'
chipper1X'chipper1X'
chipper2X'chipper2X'
etna'etna'
stripeM2'stripeM2'
stripeS700'stripeS700'
stripeS700DevKit'stripeS700Devkit'
wiseCube'wiseCube'
wisePad3'wisePad3'
wisePosE'wisePosE'
wisePosEDevKit'wisePosEDevkit'
unknown'unknown'
\n\n

enum DisconnectReason

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
DisconnectRequested'DISCONNECT_REQUESTED'
RebootRequested'REBOOT_REQUESTED'
SecurityReboot'SECURITY_REBOOT'
CriticallyLowBattery'CRITICALLY_LOW_BATTERY'
PoweredOff'POWERED_OFF'
BluetoothDisabled'BLUETOOTH_DISABLED'
\n\n

enum ConnectionStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotConnected'NOT_CONNECTED'
Connecting'CONNECTING'
Connected'CONNECTED'
\n\n

enum ReaderEvent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
CardInserted'CARD_INSERTED'
CardRemoved'CARD_REMOVED'
\n\n

enum ReaderDisplayMessage

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
CheckMobileDevice'CHECK_MOBILE_DEVICE'
RetryCard'RETRY_CARD'
InsertCard'INSERT_CARD'
InsertOrSwipeCard'INSERT_OR_SWIPE_CARD'
SwipeCard'SWIPE_CARD'
RemoveCard'REMOVE_CARD'
MultipleContactlessCardsDetected'MULTIPLE_CONTACTLESS_CARDS_DETECTED'
TryAnotherReadMethod'TRY_ANOTHER_READ_METHOD'
TryAnotherCard'TRY_ANOTHER_CARD'
CardRemovedTooEarly'CARD_REMOVED_TOO_EARLY'
\n\n

enum ReaderInputOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
None'NONE'
Insert'INSERT'
Swipe'SWIPE'
Tap'TAP'
ManualEntry'MANUAL_ENTRY'
\n\n

enum PaymentStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotReady'NOT_READY'
Ready'READY'
WaitingForInput'WAITING_FOR_INPUT'
Processing'PROCESSING'
\n\n

enum TapToPayDarkMode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
System'SYSTEM'
Dark'DARK'
Light'LIGHT'

DeviceGroupDeviceType をリーダー画像グループへ対応付けます。画像選択用の参照専用列挙型であり、discoverReadersconnectReader には渡しません。

\n\n\n
", + "html": "

@capacitor-community/stripe-terminal v8.2.1 のリファレンスです。接続方式と Tap to Pay API の対応状況は設定を参照してください。

\n

メソッド

\n

method initialize(...)

Initializes the Stripe Terminal SDK and its connection-token provider.
\nCall this once before discovering readers.

When tokenProviderEndpoint is provided, the plugin sends a POST request
\nand expects { secret: string }. When it is omitted, handle
\nRequestedConnectionToken and call setConnectionToken() instead.

initialize(options: StripeTerminalInitializationOptions) => Promise<void>

\n\n\n\n

method discoverReaders(...)

Discovers readers using the requested transport. The returned readers are
\nsnapshots; listen for DiscoveredReaders when continuous discovery can
\nproduce additional results.

discoverReaders(options: DiscoverReadersOptions) => Promise<{ readers: ReaderInterface[]; }>

\n\n\n

method setConnectionToken(...)

Supplies a connection-token secret after RequestedConnectionToken is
\nemitted. Create each token on your server and use it only once.

setConnectionToken(options: SetConnectionTokenOptions) => Promise<void>

\n\n\n

method setSimulatorConfiguration(...)

Configures the simulated reader used in test mode. Call before the
\noperation whose behavior you want to simulate.

Stripe docs reference

setSimulatorConfiguration(options: SimulatorConfigurationOptions) => Promise<void>

\n\n\n\n

method connectReader(...)

Connects to a reader returned by discoverReaders().

connectReader(options: ConnectReaderOptions) => Promise<void>

\n\n\n

method getConnectedReader()

Returns the currently connected reader, or null when disconnected.

getConnectedReader() => Promise<{ reader: ReaderInterface | null; }>

\n\n\n

method disconnectReader()

Disconnects the active reader. Resolves immediately if none is connected.

disconnectReader() => Promise<void>

\n\n\n

method cancelDiscoverReaders()

Cancels the active reader-discovery operation.

cancelDiscoverReaders() => Promise<void>

\n\n\n

method collectPaymentMethod(...)

Collects a payment method for a server-created PaymentIntent. Confirm the
\ncollected intent with confirmPaymentIntent().

collectPaymentMethod(options: CollectPaymentMethodOptions) => Promise<void>

\n\n\n

method cancelCollectPaymentMethod()

Cancels an in-progress collectPaymentMethod() call.

cancelCollectPaymentMethod() => Promise<void>

\n\n\n

method confirmPaymentIntent()

Confirms the PaymentIntent most recently collected by the reader.

confirmPaymentIntent() => Promise<void>

\n\n\n

method installAvailableUpdate()

Installs the software update reported by ReportAvailableUpdate.

installAvailableUpdate() => Promise<void>

\n\n\n

method cancelInstallUpdate()

Cancels an in-progress optional reader software update.

cancelInstallUpdate() => Promise<void>

\n\n\n

method setReaderDisplay(...)

Displays cart details on a reader with a customer-facing display.

setReaderDisplay(options: Cart) => Promise<void>

\n\n\n

method clearReaderDisplay()

Clears cart details from the reader's customer-facing display.

clearReaderDisplay() => Promise<void>

\n\n\n

method rebootReader()

Reboots the connected reader. Supported reader types are platform dependent.

rebootReader() => Promise<void>

\n\n\n

method cancelReaderReconnection()

Cancels an automatic reader reconnection attempt.

cancelReaderReconnection() => Promise<void>

\n\n\n

method setTapToPayUxConfiguration(...)

Configure the Tap to Pay UX appearance (Android only).
\nCall this after initialize() but before connectReader().
\nHas no effect on iOS or web platforms.

setTapToPayUxConfiguration(options: TapToPayUxConfiguration) => Promise<void>

\n\n\n

method isTapToPayAccountLinked(...)

Check whether the merchant has accepted Apple's Tap to Pay on iPhone
\nTerms and Conditions.

iOS only, and requires iOS 16.4 or later. initialize() must have been
\ncalled first because the SDK needs a connection token provider, but no
\nreader connection is required and the call does not activate the device.

The answer is read from Apple on every call. Apple's Tap to Pay on iPhone
\nrequirements state that acceptance state must be retrieved from Apple
\nrather than from a local variable, so do not cache the result.

Stripe docs reference

isTapToPayAccountLinked(options?: IsTapToPayAccountLinkedOptions | undefined) => Promise<{ isLinked: boolean; }>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.Loaded, ...)

Emitted after the Terminal SDK has initialized.

addListener(eventName: TerminalEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.RequestedConnectionToken, ...)

Emitted when the SDK needs a connection token and no token endpoint was
\nconfigured. Respond by calling setConnectionToken().

addListener(eventName: TerminalEventsEnum.RequestedConnectionToken, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DiscoveredReaders, ...)

Emitted whenever discovery produces an updated reader list. During iOS
\nBluetooth discovery this event can be emitted multiple times.

https://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetoothhttps://docs.stripe.com/terminal/payments/connect-reader?terminal-sdk-platform=ios&reader-type=bluetooth

addListener(eventName: TerminalEventsEnum.DiscoveredReaders, listenerFunc: ({ readers }: { readers: ReaderInterface[]; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ConnectedReader, ...)

Emitted after a reader connects successfully.

addListener(eventName: TerminalEventsEnum.ConnectedReader, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.DisconnectedReader, ...)

Emitted when the reader is disconnected, either in response to disconnectReader()
\nor some connection error.

For all reader types, this is emitted in response to disconnectReader()
\nwithout a reason property.

For Bluetooth and USB readers, this is emitted with a reason property when the reader disconnects.

Note: For Bluetooth and USB readers, when you call disconnectReader(), this event
\nwill be emitted twice: one without a reason in acknowledgement of your call, and again with a reason when the reader
\nfinishes disconnecting.

addListener(eventName: TerminalEventsEnum.DisconnectedReader, listenerFunc: ({ reason }: { reason?: DisconnectReason | undefined; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConnectionStatusChange, ...)

Emitted when the Terminal's connection status changed.

Note: You should not use this method to detect when a reader unexpectedly disconnects from your app,
\nas it cannot be used to accurately distinguish between expected and unexpected disconnect events.

To detect unexpected disconnects (e.g. to automatically notify your user), you should instead use
\nthe UnexpectedReaderDisconnect event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ConnectionStatusChange, listenerFunc: ({ status }: { status: ConnectionStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.UnexpectedReaderDisconnect, ...)

The Terminal disconnected unexpectedly from the reader.

In your implementation of this method, you may want to notify your user that the reader disconnected.
\nYou may also call discoverReaders() to begin scanning for readers, and attempt
\nto automatically reconnect to the disconnected reader. Be sure to either set a timeout or make it
\npossible to cancel calls to discoverReaders()

When connected to a Bluetooth or USB reader, you can get more information about the disconnect by
\nimplementing the DisconnectedReader event.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.UnexpectedReaderDisconnect, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ConfirmedPaymentIntent, ...)

Emitted after confirmPaymentIntent() succeeds.

addListener(eventName: TerminalEventsEnum.ConfirmedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.CollectedPaymentIntent, ...)

Emitted after collectPaymentMethod() succeeds.

addListener(eventName: TerminalEventsEnum.CollectedPaymentIntent, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Canceled, ...)

Emitted when cancelCollectPaymentMethod() is called and succeeds.
\nThe Promise returned by cancelCollectPaymentMethod() will also be resolved.

addListener(eventName: TerminalEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.Failed, ...)

Emitted when either collectPaymentMethod() or confirmPaymentIntent()
\nfails. The Promise returned by the relevant call will also be rejected.

addListener(eventName: TerminalEventsEnum.Failed, listenerFunc: (info: { message: string; code?: string; declineCode?: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReportAvailableUpdate, ...)

Emitted when a software update is available for the connected reader.

addListener(eventName: TerminalEventsEnum.ReportAvailableUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.StartInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the connected reader begins installing a software update.
\nIf a mandatory software update is available when a reader first connects, that update is
\nautomatically installed. The update will be installed before ConnectedReader is emitted and
\nbefore the Promise returned by connectReader() resolves.
\nIn this case, you will receive this sequence of events:

    \n
  1. StartInstallingUpdate
  2. \n
  3. ReaderSoftwareUpdateProgress (repeatedly)
  4. \n
  5. FinishInstallingUpdates
  6. \n
  7. ConnectedReader
  8. \n
  9. connectReader() Promise resolves
  10. \n

Your app should show UI to the user indicating that a software update is being installed
\nto explain why connecting is taking longer than usual.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.StartInstallingUpdate, listenerFunc: ({ update }: { update: ReaderSoftwareUpdateInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderSoftwareUpdateProgress, ...)

Only applicable to Bluetooth and USB readers.

Emitted periodically while reader software is updating to inform of the installation progress.
\nprogress is a float between 0 and 1.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderSoftwareUpdateProgress, listenerFunc: ({ progress }: { progress: number; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.FinishInstallingUpdate, ...)

Only applicable to Bluetooth and USB readers.

Emitted when reader software installation finishes. The callback contains
\neither the installed update or an error.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.FinishInstallingUpdate, listenerFunc: (args: { update: ReaderSoftwareUpdateInterface; } | { error: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.BatteryLevel, ...)

Only applicable to Bluetooth and USB readers.

Emitted upon connection and every 10 minutes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.BatteryLevel, listenerFunc: ({ level, charging, status }: { level: number; charging: boolean; status: BatteryStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.ReaderEvent, ...)

Only applicable to Bluetooth and USB readers.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.ReaderEvent, listenerFunc: ({ event }: { event: ReaderEvent; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.RequestDisplayMessage, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the Terminal requests that a message be displayed in your app.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestDisplayMessage, listenerFunc: ({ messageType, message }: { messageType: ReaderDisplayMessage; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.RequestReaderInput, ...)

Only applicable to Bluetooth and USB readers.

Emitted when the reader begins waiting for input. Your app should prompt the customer
\nto present a source using one of the given input options. If the reader emits a message,
\nthe RequestDisplayMessage event will be emitted.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.RequestReaderInput, listenerFunc: ({ options, message }: { options: ReaderInputOption[]; message: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n\n

method addListener(TerminalEventsEnum.PaymentStatusChange, ...)

Emitted when the Terminal SDK's payment collection status changes.

Stripe docs reference

addListener(eventName: TerminalEventsEnum.PaymentStatusChange, listenerFunc: ({ status }: { status: PaymentStatus; }) => void) => Promise<PluginListenerHandle>

\n\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectStarted, ...)

Emitted when automatic reader reconnection begins.

addListener(eventName: TerminalEventsEnum.ReaderReconnectStarted, listenerFunc: ({ reader, reason }: { reader: ReaderInterface; reason: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectSucceeded, ...)

Emitted when automatic reader reconnection succeeds.

addListener(eventName: TerminalEventsEnum.ReaderReconnectSucceeded, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(TerminalEventsEnum.ReaderReconnectFailed, ...)

Emitted when automatic reader reconnection fails.

addListener(eventName: TerminalEventsEnum.ReaderReconnectFailed, listenerFunc: ({ reader }: { reader: ReaderInterface; }) => void) => Promise<PluginListenerHandle>

addListener オーバーロードは個別のメソッドシグネチャです。下の TerminalEventsEnum 表はメンバー名と文字列値だけを示し、オーバーロードは繰り返しません。

DiscoveringReadersCancelDiscoveredReaders は列挙型に含まれ、ネイティブの探索処理から送出されますが、この一覧に型付きオーバーロードはありません。

\n\n\n\n\n

インターフェース

\n

interface DiscoverReadersOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
typeTerminalConnectTypesDiscovery method and reader transport to use.5.1.0
locationIdstringStripe Terminal Location ID used to scope internet reader discovery and reader registration where required.5.1.0
bluetoothScanWaitTimenumberOnly applies to Bluetooth scan discovery (iOS only). During discovery, readers are reported via DiscoveryDelegate.didUpdateDiscoveredReaders. This timeout controls how long to wait before resolving the discoverReaders method with the current list. If this setting is not specified or is set to 0, the initial scan results will be returned.7.2.0
\n\n

interface TapToPayUxConfiguration

Configuration for the Tap to Pay UX (Android only).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
colorsTapToPayColorSchemeColor scheme for the Tap to Pay screen.8.1.0
darkModeTapToPayDarkModeDark-mode setting for the Tap to Pay screen.8.1.0
tapZoneTapToPayTapZonePosition of the tap indicator on screen.8.1.0
\n\n\n

interface TapToPayColorScheme

Color scheme for the Tap to Pay screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
primaryTapToPayColorPrimary color for the tap-zone indicator. Use a hex string or default.8.1.0
successTapToPayColorSuccess-state color. Use a hex string or default.8.1.0
errorTapToPayColorError-state color. Use a hex string or default.8.1.0
\n\n\n

interface IsTapToPayAccountLinkedOptions

Options for isTapToPayAccountLinked.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
onBehalfOfstringConnected account ID, for Stripe Connect platforms. Omit to check the account that owns the API key.8.2.0
\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

型エイリアス

\n

interface ReaderInterface

Snapshot of a Stripe Terminal reader returned by discovery or connection.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
serialNumberstringStable hardware serial number used as the reader's primary identifier.6.2.0
labelstringHuman-readable reader label.6.2.0
batteryLevelnumberReader battery level from 0 to 1.6.2.0
batteryStatusBatteryStatusCurrent reader battery status.6.2.0
simulatedbooleanWhether this is a simulated reader.6.2.0
idnumberPlatform-specific numeric reader identifier.6.2.0
availableUpdateReaderSoftwareUpdateInterfaceAvailable reader software update, when one has been reported.6.2.0
locationIdstringStripe Terminal Location ID assigned to the reader.6.2.0
ipAddressstringReader IP address when available.6.2.0
statusNetworkStatusCurrent network status of the reader.6.2.0
locationLocationInterfaceLocation details returned with the reader, when available.6.2.0
locationStatusLocationStatusCurrent location-assignment status.6.2.0
deviceTypeDeviceTypeReader hardware type.6.2.0
deviceSoftwareVersionstring | nullInstalled reader software version, when reported by the SDK.6.2.0
isChargingnumberiOS Only properties. These properties are not available on Android.6.2.0
baseUrlstringAndroid Only properties. These properties are not available on iOS.6.2.0
bootloaderVersionstringAndroid reader bootloader version.6.2.0
configVersionstringAndroid reader configuration version.6.2.0
emvKeyProfileIdstringAndroid reader EMV key-profile identifier.6.2.0
firmwareVersionstringAndroid reader firmware version.6.2.0
hardwareVersionstringAndroid reader hardware version.6.2.0
macKeyProfileIdstringAndroid reader MAC key-profile identifier.6.2.0
pinKeyProfileIdstringAndroid reader PIN key-profile identifier.6.2.0
trackKeyProfileIdstringAndroid reader track key-profile identifier.6.2.0
settingsVersionstringAndroid reader settings version.6.2.0
pinKeysetIdstringAndroid reader PIN keyset identifier.6.2.0
\n\n\n

interface ReaderSoftwareUpdateInterface

Metadata for an available reader software update.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
deviceSoftwareVersionstringSoftware version offered by the update.6.1.0
estimatedUpdateTimeUpdateTimeEstimateEstimated duration of the update.6.1.0
requiredAtnumberUnix timestamp after which the update becomes required.6.1.0
\n\n\n

interface LocationInterface

Stripe Terminal Location assigned to a reader.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
idstringStripe Terminal Location ID.6.2.0
displayNamestringDisplay name configured for the location.6.2.0
addressLocationAddressPostal address configured for the location.6.2.0
ipAddressstringLocation IP address when provided by the SDK.6.2.0
\n\n\n

interface Cart

<a href=\"#cart\">Cart</a> totals displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
currencystringThree-letter ISO 4217 currency code.6.2.0
taxnumberTax amount in the currency's smallest unit.6.2.0
totalnumberCart total in the currency's smallest unit.6.2.0
lineItemsCartLineItem[]Items displayed in the cart.6.2.0
\n\n\n

interface CartLineItem

Line item displayed on a reader's customer-facing screen.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
displayNamestringItem name shown on the reader.6.2.0
quantitynumberNumber of units in the cart.6.2.0
amountnumberLine-item amount in the currency's smallest unit.6.2.0
\n\n\n

type alias TapToPayColor

'default' | string

\n\n

type alias TapToPayTapZone

{ type: 'default' } | { type: 'front'; xBias: number; yBias: number } | { type: 'behind'; xBias: number; yBias: number } | { type: 'above'; bias?: number } | { type: 'below'; bias?: number } | { type: 'left'; bias?: number } | { type: 'right'; bias?: number }

TerminalResultInterface は支払い結果イベント ConfirmedPaymentIntentCollectedPaymentIntentCanceledFailed の共用体です。confirmPaymentIntent() の戻り値ではなく、利便性のための別名です。

\n\n\n

列挙型

\n

enum TerminalConnectTypes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Simulated'simulated'
Internet'internet'
Bluetooth'bluetooth'
Usb'usb'
TapToPay'tap-to-pay'
HandOff'hand-off'
\n\n

enum TerminalEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'terminalLoaded'
DiscoveredReaders'terminalDiscoveredReaders'
DiscoveringReaders'terminalDiscoveringReaders'
CancelDiscoveredReaders'terminalCancelDiscoveredReaders'
ConnectedReader'terminalConnectedReader'
DisconnectedReader'terminalDisconnectedReader'
ConnectionStatusChange'terminalConnectionStatusChange'
UnexpectedReaderDisconnect'terminalUnexpectedReaderDisconnect'
ConfirmedPaymentIntent'terminalConfirmedPaymentIntent'
CollectedPaymentIntent'terminalCollectedPaymentIntent'
Canceled'terminalCanceled'
Failed'terminalFailed'
RequestedConnectionToken'terminalRequestedConnectionToken'
ReportAvailableUpdate'terminalReportAvailableUpdate'
StartInstallingUpdate'terminalStartInstallingUpdate'
ReaderSoftwareUpdateProgress'terminalReaderSoftwareUpdateProgress'
FinishInstallingUpdate'terminalFinishInstallingUpdate'
BatteryLevel'terminalBatteryLevel'
ReaderEvent'terminalReaderEvent'
RequestDisplayMessage'terminalRequestDisplayMessage'
RequestReaderInput'terminalRequestReaderInput'
PaymentStatusChange'terminalPaymentStatusChange'
ReaderReconnectStarted'terminalReaderReconnectStarted'
ReaderReconnectSucceeded'terminalReaderReconnectSucceeded'
ReaderReconnectFailed'terminalReaderReconnectFailed'
\n\n

enum SimulateReaderUpdate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
UpdateAvailable'UPDATE_AVAILABLE'
None'NONE'
Required'REQUIRED'
Random'RANDOM'
LowBattery'LOW_BATTERY'
LowBatterySucceedConnect'LOW_BATTERY_SUCCEED_CONNECT'
\n\n

enum SimulatedCardType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Visa'VISA'
VisaDebit'VISA_DEBIT'
Mastercard'MASTERCARD'
MastercardDebit'MASTERCARD_DEBIT'
MastercardPrepaid'MASTERCARD_PREPAID'
Amex'AMEX'
Amex2'AMEX_2'
Discover'DISCOVER'
Discover2'DISCOVER_2'
DinersClub'DINERS'
DinersClulb14Digits'DINERS_14_DIGITS'
JCB'JCB'
UnionPay'UNION_PAY'
Interac'INTERAC'
EftposAustraliaDebit'EFTPOS_AU_DEBIT'
VisaUsCommonDebit'VISA_US_COMMON_DEBIT'
ChargeDeclined'CHARGE_DECLINED'
ChargeDeclinedInsufficientFunds'CHARGE_DECLINED_INSUFFICIENT_FUNDS'
ChargeDeclinedLostCard'CHARGE_DECLINED_LOST_CARD'
ChargeDeclinedStolenCard'CHARGE_DECLINED_STOLEN_CARD'
ChargeDeclinedExpiredCard'CHARGE_DECLINED_EXPIRED_CARD'
ChargeDeclinedProcessingError'CHARGE_DECLINED_PROCESSING_ERROR'
EftposAustraliaVisaDebit'EFTPOS_AU_VISA_DEBIT'
EftposAustraliaMastercardDebit'EFTPOS_AU_DEBIT_MASTERCARD'
OfflinePinCVM'OFFLINE_PIN_CVM'
OfflinePinSCARetry'OFFLINE_PIN_SCA_RETRY'
OnlinePinCVM'ONLINE_PIN_CVM'
OnlinePinSCARetry'ONLINE_PIN_SCA_RETRY'
\n\n

enum BatteryStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Critical'CRITICAL'
Low'LOW'
Nominal'NOMINAL'
\n\n

enum UpdateTimeEstimate

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
LessThanOneMinute'LESS_THAN_ONE_MINUTE'
OneToTwoMinutes'ONE_TO_TWO_MINUTES'
TwoToFiveMinutes'TWO_TO_FIVE_MINUTES'
FiveToFifteenMinutes'FIVE_TO_FIFTEEN_MINUTES'
\n\n

enum NetworkStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
Online'ONLINE'
Offline'OFFLINE'
\n\n

enum LocationStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
NotSet'NOT_SET'
Set'SET'
Unknown'UNKNOWN'
\n\n

enum DeviceType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
tapToPayDevice'tapToPayDevice'
wisePad3s'wisePad3s'
appleBuiltIn'appleBuiltIn'
chipper1X'chipper1X'
chipper2X'chipper2X'
etna'etna'
stripeM2'stripeM2'
stripeS700'stripeS700'
stripeS700DevKit'stripeS700Devkit'
wiseCube'wiseCube'
wisePad3'wisePad3'
wisePosE'wisePosE'
wisePosEDevKit'wisePosEDevkit'
unknown'unknown'
\n\n

enum DisconnectReason

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
DisconnectRequested'DISCONNECT_REQUESTED'
RebootRequested'REBOOT_REQUESTED'
SecurityReboot'SECURITY_REBOOT'
CriticallyLowBattery'CRITICALLY_LOW_BATTERY'
PoweredOff'POWERED_OFF'
BluetoothDisabled'BLUETOOTH_DISABLED'
\n\n

enum ConnectionStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotConnected'NOT_CONNECTED'
Connecting'CONNECTING'
Connected'CONNECTED'
\n\n

enum ReaderEvent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
CardInserted'CARD_INSERTED'
CardRemoved'CARD_REMOVED'
\n\n

enum ReaderDisplayMessage

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
CheckMobileDevice'CHECK_MOBILE_DEVICE'
RetryCard'RETRY_CARD'
InsertCard'INSERT_CARD'
InsertOrSwipeCard'INSERT_OR_SWIPE_CARD'
SwipeCard'SWIPE_CARD'
RemoveCard'REMOVE_CARD'
MultipleContactlessCardsDetected'MULTIPLE_CONTACTLESS_CARDS_DETECTED'
TryAnotherReadMethod'TRY_ANOTHER_READ_METHOD'
TryAnotherCard'TRY_ANOTHER_CARD'
CardRemovedTooEarly'CARD_REMOVED_TOO_EARLY'
\n\n

enum ReaderInputOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
None'NONE'
Insert'INSERT'
Swipe'SWIPE'
Tap'TAP'
ManualEntry'MANUAL_ENTRY'
\n\n

enum PaymentStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Unknown'UNKNOWN'
NotReady'NOT_READY'
Ready'READY'
WaitingForInput'WAITING_FOR_INPUT'
Processing'PROCESSING'
\n\n

enum TapToPayDarkMode

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
System'SYSTEM'
Dark'DARK'
Light'LIGHT'

DeviceGroupDeviceType をリーダー画像グループへ対応付けます。画像選択用の参照専用列挙型であり、discoverReadersconnectReader には渡しません。

\n\n\n
", "headings": [ { "id": "%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89", diff --git a/projects/docs/src/app/generated/projects/stripe.en.generated.ts b/projects/docs/src/app/generated/projects/stripe.en.generated.ts index dfcb7b2..6d99d53 100644 --- a/projects/docs/src/app/generated/projects/stripe.en.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe.en.generated.ts @@ -124,7 +124,7 @@ export const PROJECT = { "file": "learn/event-listeners.md", "section": "Learn", "path": "/projects/capacitor-stripe/docs/learn/event-listeners", - "html": "

Use result events as the default result path. Register application-level result listeners once per JavaScript application startup, as early as possible during bootstrap—for example from main.ts, an application initializer, or a singleton service initialized at startup—and before presenting Stripe UI.

\n
import {\n  ApplePayEventsEnum,\n  GooglePayEventsEnum,\n  PaymentFlowEventsEnum,\n  PaymentSheetEventsEnum,\n  Stripe,\n} from '@capacitor-community/stripe';\n\nawait Promise.all([\n  Stripe.addListener(PaymentSheetEventsEnum.Completed, () => handleCompleted()),\n  Stripe.addListener(PaymentSheetEventsEnum.Canceled, () => handleCanceled()),\n  Stripe.addListener(PaymentSheetEventsEnum.Failed, (error) => handleFailed(error)),\n]);\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

Android activity recreation

\n

This is especially important on Android, where the Activity and JavaScript runtime can be recreated while Stripe's UI is open. The new JavaScript runtime must register its listeners during bootstrap.

\n

The original JavaScript Promise and Capacitor PluginCall cannot be restored. If Stripe delivers the native result after recreation, the plugin retains the corresponding result event until a listener is available. This applies to the Completed, Canceled, and Failed events for PaymentSheet, PaymentFlow, and Google Pay, and to the Created event for PaymentFlow.

\n

If the original call still exists, behavior is unchanged: the Promise is settled normally and the event is delivered without being retained. This fallback is an in-memory handoff of a native result; it is not persistent storage and does not guarantee recovery after OS process death.

\n

Keep application-level result listeners registered for the lifetime of the JavaScript runtime. Do not add them in a button handler and remove them when a page unmounts if you still need the payment result after Android recreation.

\n

PaymentSheet events

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'

Typical PaymentSheet flow:

    \n
  1. Register result listeners at startup.
  2. \n
  3. Call createPaymentSheet().
  4. \n
  5. Wait for Loaded, or handle FailedToLoad.
  6. \n
  7. Call presentPaymentSheet().
  8. \n
  9. Receive one of Completed, Canceled, or Failed.
  10. \n

Canceled means the customer dismissed the sheet. Treat it as cancellation, not as a thrown error. Failed and FailedToLoad include an error string. Do not fulfill an order from the client event alone; confirm the PaymentIntent or SetupIntent with a webhook.

\n\n\n\n\n

PaymentFlow events

\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'

Typical PaymentFlow flow:

    \n
  1. Register result listeners at startup.
  2. \n
  3. Call createPaymentFlow().
  4. \n
  5. Wait for Loaded, or handle FailedToLoad.
  6. \n
  7. Call presentPaymentFlow().
  8. \n
  9. Receive Opened, then Created with { cardNumber }, or Canceled.
  10. \n
  11. Call confirmPaymentFlow().
  12. \n
  13. Receive one of Completed, Canceled, or Failed.
  14. \n
\n\n\n\n

Apple Pay events

\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'

DidSelectShippingContact includes contact and updateId. On iOS, call updateApplePaySheet with that updateId and updated paymentSummaryItems. If JavaScript does not respond, the native sheet falls back to the original items after 25 seconds. updateApplePaySheet is not implemented on Android or web.

DidCreatePaymentMethod includes the shipping contact. Apple does not return the full address until a successful payment.

\n\n\n\n

Google Pay events

\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'

Google Pay is available on Android and web. It is not implemented on iOS.

\n\n\n", + "html": "

Use result events as the default result path. Register application-level result listeners once per JavaScript application startup, as early as possible during bootstrap—for example from main.ts, an application initializer, or a singleton service initialized at startup—and before presenting Stripe UI.

\n
import {\n  ApplePayEventsEnum,\n  GooglePayEventsEnum,\n  PaymentFlowEventsEnum,\n  PaymentSheetEventsEnum,\n  Stripe,\n} from '@capacitor-community/stripe';\n\nawait Promise.all([\n  Stripe.addListener(PaymentSheetEventsEnum.Completed, () => handleCompleted()),\n  Stripe.addListener(PaymentSheetEventsEnum.Canceled, () => handleCanceled()),\n  Stripe.addListener(PaymentSheetEventsEnum.Failed, (error) => handleFailed(error)),\n]);\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

Android activity recreation

\n

This is especially important on Android, where the Activity and JavaScript runtime can be recreated while Stripe's UI is open. The new JavaScript runtime must register its listeners during bootstrap.

\n

The original JavaScript Promise and Capacitor PluginCall cannot be restored. If Stripe delivers the native result after recreation, the plugin retains the corresponding result event until a listener is available. This applies to the Completed, Canceled, and Failed events for PaymentSheet, PaymentFlow, and Google Pay, and to the Created event for PaymentFlow.

\n

If the original call still exists, behavior is unchanged: the Promise is settled normally and the event is delivered without being retained. This fallback is an in-memory handoff of a native result; it is not persistent storage and does not guarantee recovery after OS process death.

\n

Keep application-level result listeners registered for the lifetime of the JavaScript runtime. Do not add them in a button handler and remove them when a page unmounts if you still need the payment result after Android recreation.

\n

PaymentSheet events

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'

Typical PaymentSheet flow:

    \n
  1. Register result listeners at startup.
  2. \n
  3. Call createPaymentSheet().
  4. \n
  5. Wait for Loaded, or handle FailedToLoad.
  6. \n
  7. Call presentPaymentSheet().
  8. \n
  9. Receive one of Completed, Canceled, or Failed.
  10. \n

Canceled means the customer dismissed the sheet. Treat it as cancellation, not as a thrown error. Failed and FailedToLoad include an error string. Do not fulfill an order from the client event alone; confirm the PaymentIntent or SetupIntent with a webhook.

\n\n\n\n\n

PaymentFlow events

\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'

Typical PaymentFlow flow:

    \n
  1. Register result listeners at startup.
  2. \n
  3. Call createPaymentFlow().
  4. \n
  5. Wait for Loaded, or handle FailedToLoad.
  6. \n
  7. Call presentPaymentFlow().
  8. \n
  9. Receive Opened, then Created with { cardNumber }, or Canceled.
  10. \n
  11. Call confirmPaymentFlow().
  12. \n
  13. Receive one of Completed, Canceled, or Failed.
  14. \n
\n\n\n\n

Apple Pay events

\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'

DidSelectShippingContact includes contact and updateId. On iOS, call updateApplePaySheet with that updateId and updated paymentSummaryItems. If JavaScript does not respond, the native sheet falls back to the original items after 25 seconds. updateApplePaySheet is not implemented on Android or web.

DidCreatePaymentMethod includes the shipping contact. Apple does not return the full address until a successful payment.

\n\n\n\n

Google Pay events

\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'

Google Pay is available on Android and web. It is not implemented on iOS.

\n\n\n", "headings": [ { "id": "method-addlistener(applepayeventsenum.loaded%2C-...)", @@ -1207,7 +1207,7 @@ export const PROJECT = { "file": "api.md", "section": "Reference", "path": "/projects/capacitor-stripe/docs/api", - "html": "

Reference generated from the public API metadata for @capacitor-community/stripe v8.2.1. Platform limits, inherited option fields, result listener lifecycle, and server responsibilities are documented on the method pages.

\n

Methods

\n

method initialize(...)

Configures the Stripe SDK. Call this once before using any payment method.

initialize(opts: StripeInitializationOptions) => Promise<void>

\n\n\n

method handleURLCallback(...)

Passes an incoming return URL back to the Stripe SDK after redirect-based
\nauthentication.

iOS only. Call this from your app URL handler when Stripe redirects back
\nto the application.

handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>

\n\n\n\n

method isApplePayAvailable()

Resolves when Apple Pay is available and rejects when it is unavailable.
\nApple Pay is supported on iOS and compatible web browsers, not Android.

isApplePayAvailable() => Promise<void>

\n\n\n

method createApplePay(...)

Creates an Apple Pay request. Call this before presentApplePay().

createApplePay(options: CreateApplePayOption) => Promise<void>

\n\n\n

method presentApplePay()

Presents the Apple Pay request created by createApplePay().

presentApplePay() => Promise<{ paymentResult: ApplePayResultInterface; }>

\n\n\n

method updateApplePaySheet(...)

Updates the native Apple Pay sheet after a shipping-contact callback.
\niOS only; this method is not supported on web.

updateApplePaySheet(options: UpdateApplePaySheetOption) => Promise<void>

\n\n\n

method isGooglePayAvailable()

Resolves when Google Pay is available and rejects when it is unavailable.
\nGoogle Pay is supported on Android and compatible web browsers, not iOS.

isGooglePayAvailable() => Promise<void>

\n\n\n

method createGooglePay(...)

Creates a Google Pay request. Call this before presentGooglePay().

createGooglePay(options: CreateGooglePayOption) => Promise<void>

\n\n\n

method presentGooglePay()

Presents the Google Pay request created by createGooglePay().

presentGooglePay() => Promise<{ paymentResult: GooglePayResultInterface; }>

\n\n\n

method createPaymentFlow(...)

Creates a PaymentFlow instance. Use PaymentFlow when the app must collect
\npayment details first and confirm them in a later step.

createPaymentFlow(options: CreatePaymentFlowOption) => Promise<void>

\n\n\n

method presentPaymentFlow()

Presents the PaymentFlow created by createPaymentFlow() and resolves
\nwith the last four digits of the selected card.

presentPaymentFlow() => Promise<{ cardNumber: string; }>

\n\n\n

method confirmPaymentFlow()

Confirms the payment details collected by presentPaymentFlow().

confirmPaymentFlow() => Promise<{ paymentResult: PaymentFlowResultInterface; }>

\n\n\n

method createPaymentSheet(...)

Creates and configures a PaymentSheet instance. Wait for this Promise or
\nthe Loaded event before calling presentPaymentSheet().

createPaymentSheet(options: CreatePaymentSheetOption) => Promise<void>

\n\n\n

method presentPaymentSheet()

Presents the PaymentSheet created by createPaymentSheet() and resolves
\nwith its completed, canceled, or failed result.

presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetResultInterface; }>

\n\n\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

Interfaces

\n

Inherited PaymentSheet and PaymentFlow options

\n

CreatePaymentSheetOption and CreatePaymentFlowOption extend the exported BasePaymentOption. The docgen metadata does not expand inherited fields, so they are listed here explicitly.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypePlatform / purpose
defaultBillingDetailsDefaultBillingDetailsiOS and Android
shippingDetailsAddressDetailsAndroid
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationiOS and Android
customerEphemeralKeySecretstringUse with customerId
customerIdstringStripe Customer
enableApplePaybooleanNative PaymentSheet
applePayMerchantIdstringRequired when Apple Pay is enabled
enableGooglePaybooleanNative PaymentSheet
GooglePayIsTestingbooleanAndroid Google Pay test mode
countryCodestringWallet country, default US
merchantDisplayNamestringPaymentSheet merchant name
returnURLstringiOS redirect-based authentication
paymentMethodLayout'horizontal' | 'vertical' | 'automatic'Android
style'alwaysLight' | 'alwaysDark'iOS
withZipCodebooleanWeb
currencyCodestringGoogle Pay with native SetupIntent
\n

These are optional fields. See PaymentSheet and PaymentFlow for combinations and web limitations.

\n

interface StripeInitializationOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key for the account that creates the client-side payment UI. Never pass a secret key to the client application.3.0.0
stripeAccountstringConnected account ID used when making client-side calls on behalf of a Stripe Connect account.3.0.0
\n\n

interface StripeURLHandlingOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
urlstringFull callback URL received by the application.4.0.0
\n\n

interface CreatePaymentSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreatePaymentFlowOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreateApplePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Apple Pay.3.1.0
paymentSummaryItemsPaymentSummaryItem[]Line items displayed in the Apple Pay sheet.3.1.0
merchantIdentifierstringApple merchant identifier configured for the app.3.1.0
countryCodestringTwo-letter ISO 3166-1 country code for the payment request.3.1.0
currencystringThree-letter ISO 4217 currency code for the payment request.3.1.0
requiredShippingContactFields('postalAddress' | 'phoneNumber' | 'emailAddress' | 'name')[]Shipping contact fields Apple Pay must collect. iOS only.4.1.0
allowedCountriesstring[]Two-letter country codes accepted for shipping. iOS only.5.4.3
allowedCountriesErrorDescriptionstringMessage shown when the selected shipping country is not allowed. iOS only.5.4.3
\n\n

interface CreateGooglePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Google Pay.3.2.0
paymentSummaryItems{ label: string; amount: number; }[]Web only. Requires stripe-pwa-elements ^3.0.0.3.2.0
merchantIdentifierstringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
countryCodestringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
currencystringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
\n\n

interface PaymentSummaryItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
labelstringLabel shown for the line item in the Apple Pay sheet.3.1.0
amountnumberDecimal amount in the currency's major unit, for example 10.99.3.1.0
\n\n

interface DefaultBillingDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailstringPrefilled billing email address.7.2.0
namestringPrefilled billing name.7.2.0
phonestringPrefilled billing phone number.7.2.0
addressAddressPrefilled billing address.7.2.0
\n\n

interface Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
countrystringTwo-letter country code (ISO 3166-1 alpha-2).7.2.0
citystringCity, district, suburb, town, or village.7.2.0
line1stringPrimary address line, such as a street address or post office box.7.2.0
line2stringSecondary address line, such as an apartment or suite.7.2.0
postalCodestringZIP or postal code.7.2.0
statestringState, county, province, or region.7.2.0
\n\n

interface AddressDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
namestringRecipient name.7.2.0
addressAddressRecipient postal address.7.2.0
phonestringRecipient phone number.7.2.0
isCheckboxSelectedbooleanWhether the customer selected the save-address checkbox. Android only.7.2.0
\n\n

interface BillingDetailsCollectionConfiguration

Controls which billing details PaymentSheet collects from the customer.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailCollectionModeEmail collection mode.5.4.0
nameCollectionModeName collection mode.5.4.0
phoneCollectionModePhone-number collection mode.5.4.0
addressAddressCollectionModePostal-address collection mode.5.4.0
\n\n\n

interface DidSelectShippingContact

Apple Pay shipping-contact data.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactShipping contact selected in Apple Pay.4.1.0
updateIdstringIdentifier passed to updateApplePaySheet() for this callback.4.1.0
\n\n\n

interface DidCreatePaymentMethod

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactContact attached to the Apple Pay payment method.4.1.0
\n\n

interface ShippingContact

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
givenNamestringContact's given name. Apple Pay only.4.1.0
familyNamestringContact's family name. Apple Pay only.4.1.0
middleNamestringContact's middle name. Apple Pay only.4.1.0
namePrefixstringContact's name prefix. Apple Pay only.4.1.0
nameSuffixstringContact's name suffix. Apple Pay only.4.1.0
nameFormattedstringContact's formatted full name. Apple Pay only.4.1.0
phoneNumberstringContact's phone number. Apple Pay only.4.1.0
nicknamestringContact's nickname. Apple Pay only.4.1.0
streetstringStreet component of the contact's postal address. Apple Pay only.4.1.0
citystringCity component of the contact's postal address. Apple Pay only.4.1.0
statestringState or province component of the contact's postal address. Apple Pay only.4.1.0
postalCodestringPostal-code component of the contact's address. Apple Pay only.4.1.0
countrystringCountry or region name in the contact's address. Apple Pay only.4.1.0
isoCountryCodestringISO country code in the contact's address. Apple Pay only.4.1.0
subAdministrativeAreastringSub-administrative area in the contact's address. Apple Pay only.4.1.0
subLocalitystringSublocality in the contact's address. Apple Pay only.4.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

Type aliases

\n

type alias PaymentSheetResultInterface

PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed

\n\n

type alias PaymentFlowResultInterface

PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed

\n\n

type alias ApplePayResultInterface

ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed | ApplePayEventsEnum.DidSelectShippingContact | ApplePayEventsEnum.DidCreatePaymentMethod

\n\n

type alias GooglePayResultInterface

GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed

\n\n

type alias CollectionMode

'automatic' | 'always' | 'never'

\n\n

type alias AddressCollectionMode

'automatic' | 'full' | 'never'

\n\n

Enums

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'
\n\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'
\n\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'
\n\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'
\n\n
", + "html": "

Reference generated from the public API metadata for @capacitor-community/stripe v8.2.1. Platform limits, inherited option fields, result listener lifecycle, and server responsibilities are documented on the method pages.

\n

Methods

\n

method initialize(...)

Configures the Stripe SDK. Call this once before using any payment method.

initialize(opts: StripeInitializationOptions) => Promise<void>

\n\n\n

method handleURLCallback(...)

Passes an incoming return URL back to the Stripe SDK after redirect-based
\nauthentication.

iOS only. Call this from your app URL handler when Stripe redirects back
\nto the application.

handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>

\n\n\n\n

method isApplePayAvailable()

Resolves when Apple Pay is available and rejects when it is unavailable.
\nApple Pay is supported on iOS and compatible web browsers, not Android.

isApplePayAvailable() => Promise<void>

\n\n\n

method createApplePay(...)

Creates an Apple Pay request. Call this before presentApplePay().

createApplePay(options: CreateApplePayOption) => Promise<void>

\n\n\n

method presentApplePay()

Presents the Apple Pay request created by createApplePay().

presentApplePay() => Promise<{ paymentResult: ApplePayResultInterface; }>

\n\n\n

method updateApplePaySheet(...)

Updates the native Apple Pay sheet after a shipping-contact callback.
\niOS only; this method is not supported on web.

updateApplePaySheet(options: UpdateApplePaySheetOption) => Promise<void>

\n\n\n

method isGooglePayAvailable()

Resolves when Google Pay is available and rejects when it is unavailable.
\nGoogle Pay is supported on Android and compatible web browsers, not iOS.

isGooglePayAvailable() => Promise<void>

\n\n\n

method createGooglePay(...)

Creates a Google Pay request. Call this before presentGooglePay().

createGooglePay(options: CreateGooglePayOption) => Promise<void>

\n\n\n

method presentGooglePay()

Presents the Google Pay request created by createGooglePay().

presentGooglePay() => Promise<{ paymentResult: GooglePayResultInterface; }>

\n\n\n

method createPaymentFlow(...)

Creates a PaymentFlow instance. Use PaymentFlow when the app must collect
\npayment details first and confirm them in a later step.

createPaymentFlow(options: CreatePaymentFlowOption) => Promise<void>

\n\n\n

method presentPaymentFlow()

Presents the PaymentFlow created by createPaymentFlow() and resolves
\nwith the last four digits of the selected card.

presentPaymentFlow() => Promise<{ cardNumber: string; }>

\n\n\n

method confirmPaymentFlow()

Confirms the payment details collected by presentPaymentFlow().

confirmPaymentFlow() => Promise<{ paymentResult: PaymentFlowResultInterface; }>

\n\n\n

method createPaymentSheet(...)

Creates and configures a PaymentSheet instance. Wait for this Promise or
\nthe Loaded event before calling presentPaymentSheet().

createPaymentSheet(options: CreatePaymentSheetOption) => Promise<void>

\n\n\n

method presentPaymentSheet()

Presents the PaymentSheet created by createPaymentSheet() and resolves
\nwith its completed, canceled, or failed result.

presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetResultInterface; }>

\n\n\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

Interfaces

\n

Inherited PaymentSheet and PaymentFlow options

\n

CreatePaymentSheetOption and CreatePaymentFlowOption extend the exported BasePaymentOption. The docgen metadata does not expand inherited fields, so they are listed here explicitly.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypePlatform / purpose
defaultBillingDetailsDefaultBillingDetailsiOS and Android
shippingDetailsAddressDetailsAndroid
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationiOS and Android
customerEphemeralKeySecretstringUse with customerId
customerIdstringStripe Customer
enableApplePaybooleanNative PaymentSheet
applePayMerchantIdstringRequired when Apple Pay is enabled
enableGooglePaybooleanNative PaymentSheet
GooglePayIsTestingbooleanAndroid Google Pay test mode
countryCodestringWallet country, default US
merchantDisplayNamestringPaymentSheet merchant name
returnURLstringiOS redirect-based authentication
paymentMethodLayout'horizontal' | 'vertical' | 'automatic'Android
style'alwaysLight' | 'alwaysDark'iOS
withZipCodebooleanWeb
currencyCodestringGoogle Pay with native SetupIntent
\n

These are optional fields. See PaymentSheet and PaymentFlow for combinations and web limitations.

\n

interface StripeInitializationOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key for the account that creates the client-side payment UI. Never pass a secret key to the client application.3.0.0
stripeAccountstringConnected account ID used when making client-side calls on behalf of a Stripe Connect account.3.0.0
\n\n

interface StripeURLHandlingOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
urlstringFull callback URL received by the application.4.0.0
\n\n

interface CreatePaymentSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreatePaymentFlowOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreateApplePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Apple Pay.3.1.0
paymentSummaryItemsPaymentSummaryItem[]Line items displayed in the Apple Pay sheet.3.1.0
merchantIdentifierstringApple merchant identifier configured for the app.3.1.0
countryCodestringTwo-letter ISO 3166-1 country code for the payment request.3.1.0
currencystringThree-letter ISO 4217 currency code for the payment request.3.1.0
requiredShippingContactFields('postalAddress' | 'phoneNumber' | 'emailAddress' | 'name')[]Shipping contact fields Apple Pay must collect. iOS only.4.1.0
allowedCountriesstring[]Two-letter country codes accepted for shipping. iOS only.5.4.3
allowedCountriesErrorDescriptionstringMessage shown when the selected shipping country is not allowed. iOS only.5.4.3
\n\n

interface CreateGooglePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Google Pay.3.2.0
paymentSummaryItems{ label: string; amount: number; }[]Web only. Requires stripe-pwa-elements ^3.0.0.3.2.0
merchantIdentifierstringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
countryCodestringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
currencystringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
\n\n

interface PaymentSummaryItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
labelstringLabel shown for the line item in the Apple Pay sheet.3.1.0
amountnumberDecimal amount in the currency's major unit, for example 10.99.3.1.0
\n\n

interface DefaultBillingDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailstringPrefilled billing email address.7.2.0
namestringPrefilled billing name.7.2.0
phonestringPrefilled billing phone number.7.2.0
addressAddressPrefilled billing address.7.2.0
\n\n

interface Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
countrystringTwo-letter country code (ISO 3166-1 alpha-2).7.2.0
citystringCity, district, suburb, town, or village.7.2.0
line1stringPrimary address line, such as a street address or post office box.7.2.0
line2stringSecondary address line, such as an apartment or suite.7.2.0
postalCodestringZIP or postal code.7.2.0
statestringState, county, province, or region.7.2.0
\n\n

interface AddressDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
namestringRecipient name.7.2.0
addressAddressRecipient postal address.7.2.0
phonestringRecipient phone number.7.2.0
isCheckboxSelectedbooleanWhether the customer selected the save-address checkbox. Android only.7.2.0
\n\n

interface BillingDetailsCollectionConfiguration

Controls which billing details PaymentSheet collects from the customer.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailCollectionModeEmail collection mode.5.4.0
nameCollectionModeName collection mode.5.4.0
phoneCollectionModePhone-number collection mode.5.4.0
addressAddressCollectionModePostal-address collection mode.5.4.0
\n\n\n

interface DidSelectShippingContact

Apple Pay shipping-contact data.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactShipping contact selected in Apple Pay.4.1.0
updateIdstringIdentifier passed to updateApplePaySheet() for this callback.4.1.0
\n\n\n

interface DidCreatePaymentMethod

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactContact attached to the Apple Pay payment method.4.1.0
\n\n

interface ShippingContact

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
givenNamestringContact's given name. Apple Pay only.4.1.0
familyNamestringContact's family name. Apple Pay only.4.1.0
middleNamestringContact's middle name. Apple Pay only.4.1.0
namePrefixstringContact's name prefix. Apple Pay only.4.1.0
nameSuffixstringContact's name suffix. Apple Pay only.4.1.0
nameFormattedstringContact's formatted full name. Apple Pay only.4.1.0
phoneNumberstringContact's phone number. Apple Pay only.4.1.0
nicknamestringContact's nickname. Apple Pay only.4.1.0
streetstringStreet component of the contact's postal address. Apple Pay only.4.1.0
citystringCity component of the contact's postal address. Apple Pay only.4.1.0
statestringState or province component of the contact's postal address. Apple Pay only.4.1.0
postalCodestringPostal-code component of the contact's address. Apple Pay only.4.1.0
countrystringCountry or region name in the contact's address. Apple Pay only.4.1.0
isoCountryCodestringISO country code in the contact's address. Apple Pay only.4.1.0
subAdministrativeAreastringSub-administrative area in the contact's address. Apple Pay only.4.1.0
subLocalitystringSublocality in the contact's address. Apple Pay only.4.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

Type aliases

\n

type alias PaymentSheetResultInterface

PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed

\n\n

type alias PaymentFlowResultInterface

PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed

\n\n

type alias ApplePayResultInterface

ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed | ApplePayEventsEnum.DidSelectShippingContact | ApplePayEventsEnum.DidCreatePaymentMethod

\n\n

type alias GooglePayResultInterface

GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed

\n\n

type alias CollectionMode

'automatic' | 'always' | 'never'

\n\n

type alias AddressCollectionMode

'automatic' | 'full' | 'never'

\n\n

Enums

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'
\n\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'
\n\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'
\n\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'
\n\n
", "headings": [ { "id": "methods", diff --git a/projects/docs/src/app/generated/projects/stripe.ja.generated.ts b/projects/docs/src/app/generated/projects/stripe.ja.generated.ts index afd0308..70013b5 100644 --- a/projects/docs/src/app/generated/projects/stripe.ja.generated.ts +++ b/projects/docs/src/app/generated/projects/stripe.ja.generated.ts @@ -124,7 +124,7 @@ export const PROJECT = { "file": "learn/event-listeners.md", "section": "学ぶ", "path": "/projects/capacitor-stripe/docs/learn/event-listeners", - "html": "

結果を受け取る標準経路としてイベントを使用します。JavaScript アプリケーションの起動ごとに、アプリケーションレベルの結果リスナーを一度だけ登録してください。main.ts、アプリケーション初期化処理、起動時に生成されるシングルトンサービスなどで、Stripe の UI を表示する前のできるだけ早い段階に登録します。

\n
import {\n  ApplePayEventsEnum,\n  GooglePayEventsEnum,\n  PaymentFlowEventsEnum,\n  PaymentSheetEventsEnum,\n  Stripe,\n} from '@capacitor-community/stripe';\n\nawait Promise.all([\n  Stripe.addListener(PaymentSheetEventsEnum.Completed, () => handleCompleted()),\n  Stripe.addListener(PaymentSheetEventsEnum.Canceled, () => handleCanceled()),\n  Stripe.addListener(PaymentSheetEventsEnum.Failed, (error) => handleFailed(error)),\n]);\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

Android Activity の再生成

\n

Android では Stripe の UI が開いている間に Activity と JavaScript ランタイムが再生成されることがあるため、特に重要です。新しい JavaScript ランタイムは起動処理中にリスナーを登録し直す必要があります。

\n

元の JavaScript Promise と Capacitor の PluginCall は復元できません。再生成後に Stripe がネイティブ結果を返した場合、プラグインはリスナーが利用可能になるまで対応する結果イベントを保持します。対象は PaymentSheet、PaymentFlow、Google Pay の CompletedCanceledFailed と、PaymentFlow の Created です。

\n

元の呼び出しが残っている場合は従来どおり、Promise が解決され、イベントも保持されずに配信されます。このフォールバックはネイティブ結果をメモリ上で受け渡すものであり、永続ストレージではありません。OS によるプロセス終了後の復旧は保証しません。

\n

アプリケーションレベルの結果リスナーは JavaScript ランタイムの存続中ずっと登録しておいてください。Android の再生成後も支払い結果が必要なら、ボタンハンドラーで追加し、ページ破棄時に削除する設計にはしないでください。

\n

PaymentSheet のイベント

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'

標準的な流れは次のとおりです。

    \n
  1. 起動時に結果リスナーを登録する。
  2. \n
  3. createPaymentSheet() を呼ぶ。
  4. \n
  5. Loaded を待つか、FailedToLoad を処理する。
  6. \n
  7. presentPaymentSheet() を呼ぶ。
  8. \n
  9. CompletedCanceledFailed のいずれかを受け取る。
  10. \n

Canceled は利用者がシートを閉じたことを表し、例外ではありません。FailedFailedToLoad にはエラー文字列が含まれます。クライアントイベントだけで注文を確定せず、Webhook で PaymentIntent または SetupIntent を確認してください。

\n\n\n\n\n

PaymentFlow のイベント

\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'
    \n
  1. 起動時に結果リスナーを登録する。
  2. \n
  3. createPaymentFlow() を呼ぶ。
  4. \n
  5. Loaded を待つか、FailedToLoad を処理する。
  6. \n
  7. presentPaymentFlow() を呼ぶ。
  8. \n
  9. Opened、続いて { cardNumber } を持つ Created、または Canceled を受け取る。
  10. \n
  11. confirmPaymentFlow() を呼ぶ。
  12. \n
  13. CompletedCanceledFailed のいずれかを受け取る。
  14. \n
\n\n\n

Apple Pay のイベント

\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'

DidSelectShippingContact には contactupdateId が含まれます。iOS では、その updateId と更新後の paymentSummaryItems を指定して updateApplePaySheet を呼びます。JavaScript が応答しない場合、ネイティブシートは25秒後に元の項目へ戻ります。updateApplePaySheet は Android と Web では未実装です。

DidCreatePaymentMethod には配送先 contact が含まれます。Apple は支払いが成功するまで住所全体を返しません。

\n\n\n\n

Google Pay のイベント

\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'

Google Pay は Android と Web で利用できます。iOS では実装されていません。

\n\n\n", + "html": "

結果を受け取る標準経路としてイベントを使用します。JavaScript アプリケーションの起動ごとに、アプリケーションレベルの結果リスナーを一度だけ登録してください。main.ts、アプリケーション初期化処理、起動時に生成されるシングルトンサービスなどで、Stripe の UI を表示する前のできるだけ早い段階に登録します。

\n
import {\n  ApplePayEventsEnum,\n  GooglePayEventsEnum,\n  PaymentFlowEventsEnum,\n  PaymentSheetEventsEnum,\n  Stripe,\n} from '@capacitor-community/stripe';\n\nawait Promise.all([\n  Stripe.addListener(PaymentSheetEventsEnum.Completed, () => handleCompleted()),\n  Stripe.addListener(PaymentSheetEventsEnum.Canceled, () => handleCanceled()),\n  Stripe.addListener(PaymentSheetEventsEnum.Failed, (error) => handleFailed(error)),\n]);\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

Android Activity の再生成

\n

Android では Stripe の UI が開いている間に Activity と JavaScript ランタイムが再生成されることがあるため、特に重要です。新しい JavaScript ランタイムは起動処理中にリスナーを登録し直す必要があります。

\n

元の JavaScript Promise と Capacitor の PluginCall は復元できません。再生成後に Stripe がネイティブ結果を返した場合、プラグインはリスナーが利用可能になるまで対応する結果イベントを保持します。対象は PaymentSheet、PaymentFlow、Google Pay の CompletedCanceledFailed と、PaymentFlow の Created です。

\n

元の呼び出しが残っている場合は従来どおり、Promise が解決され、イベントも保持されずに配信されます。このフォールバックはネイティブ結果をメモリ上で受け渡すものであり、永続ストレージではありません。OS によるプロセス終了後の復旧は保証しません。

\n

アプリケーションレベルの結果リスナーは JavaScript ランタイムの存続中ずっと登録しておいてください。Android の再生成後も支払い結果が必要なら、ボタンハンドラーで追加し、ページ破棄時に削除する設計にはしないでください。

\n

PaymentSheet のイベント

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'

標準的な流れは次のとおりです。

    \n
  1. 起動時に結果リスナーを登録する。
  2. \n
  3. createPaymentSheet() を呼ぶ。
  4. \n
  5. Loaded を待つか、FailedToLoad を処理する。
  6. \n
  7. presentPaymentSheet() を呼ぶ。
  8. \n
  9. CompletedCanceledFailed のいずれかを受け取る。
  10. \n

Canceled は利用者がシートを閉じたことを表し、例外ではありません。FailedFailedToLoad にはエラー文字列が含まれます。クライアントイベントだけで注文を確定せず、Webhook で PaymentIntent または SetupIntent を確認してください。

\n\n\n\n\n

PaymentFlow のイベント

\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'
    \n
  1. 起動時に結果リスナーを登録する。
  2. \n
  3. createPaymentFlow() を呼ぶ。
  4. \n
  5. Loaded を待つか、FailedToLoad を処理する。
  6. \n
  7. presentPaymentFlow() を呼ぶ。
  8. \n
  9. Opened、続いて { cardNumber } を持つ Created、または Canceled を受け取る。
  10. \n
  11. confirmPaymentFlow() を呼ぶ。
  12. \n
  13. CompletedCanceledFailed のいずれかを受け取る。
  14. \n
\n\n\n

Apple Pay のイベント

\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'

DidSelectShippingContact には contactupdateId が含まれます。iOS では、その updateId と更新後の paymentSummaryItems を指定して updateApplePaySheet を呼びます。JavaScript が応答しない場合、ネイティブシートは25秒後に元の項目へ戻ります。updateApplePaySheet は Android と Web では未実装です。

DidCreatePaymentMethod には配送先 contact が含まれます。Apple は支払いが成功するまで住所全体を返しません。

\n\n\n\n

Google Pay のイベント

\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'

Google Pay は Android と Web で利用できます。iOS では実装されていません。

\n\n\n", "headings": [ { "id": "method-addlistener(applepayeventsenum.loaded%2C-...)", @@ -1207,7 +1207,7 @@ export const PROJECT = { "file": "api.md", "section": "リファレンス", "path": "/projects/capacitor-stripe/docs/api", - "html": "

@capacitor-community/stripe v8.2.1 の公開 API メタデータから生成したリファレンスです。プラットフォームの制限、継承されるオプションフィールド、結果リスナーのライフサイクル、サーバーの責務は各メソッドページで説明しています。

\n

メソッド

\n

method initialize(...)

Configures the Stripe SDK. Call this once before using any payment method.

initialize(opts: StripeInitializationOptions) => Promise<void>

\n\n\n

method handleURLCallback(...)

Passes an incoming return URL back to the Stripe SDK after redirect-based
\nauthentication.

iOS only. Call this from your app URL handler when Stripe redirects back
\nto the application.

handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>

\n\n\n\n

method isApplePayAvailable()

Resolves when Apple Pay is available and rejects when it is unavailable.
\nApple Pay is supported on iOS and compatible web browsers, not Android.

isApplePayAvailable() => Promise<void>

\n\n\n

method createApplePay(...)

Creates an Apple Pay request. Call this before presentApplePay().

createApplePay(options: CreateApplePayOption) => Promise<void>

\n\n\n

method presentApplePay()

Presents the Apple Pay request created by createApplePay().

presentApplePay() => Promise<{ paymentResult: ApplePayResultInterface; }>

\n\n\n

method updateApplePaySheet(...)

Updates the native Apple Pay sheet after a shipping-contact callback.
\niOS only; this method is not supported on web.

updateApplePaySheet(options: UpdateApplePaySheetOption) => Promise<void>

\n\n\n

method isGooglePayAvailable()

Resolves when Google Pay is available and rejects when it is unavailable.
\nGoogle Pay is supported on Android and compatible web browsers, not iOS.

isGooglePayAvailable() => Promise<void>

\n\n\n

method createGooglePay(...)

Creates a Google Pay request. Call this before presentGooglePay().

createGooglePay(options: CreateGooglePayOption) => Promise<void>

\n\n\n

method presentGooglePay()

Presents the Google Pay request created by createGooglePay().

presentGooglePay() => Promise<{ paymentResult: GooglePayResultInterface; }>

\n\n\n

method createPaymentFlow(...)

Creates a PaymentFlow instance. Use PaymentFlow when the app must collect
\npayment details first and confirm them in a later step.

createPaymentFlow(options: CreatePaymentFlowOption) => Promise<void>

\n\n\n

method presentPaymentFlow()

Presents the PaymentFlow created by createPaymentFlow() and resolves
\nwith the last four digits of the selected card.

presentPaymentFlow() => Promise<{ cardNumber: string; }>

\n\n\n

method confirmPaymentFlow()

Confirms the payment details collected by presentPaymentFlow().

confirmPaymentFlow() => Promise<{ paymentResult: PaymentFlowResultInterface; }>

\n\n\n

method createPaymentSheet(...)

Creates and configures a PaymentSheet instance. Wait for this Promise or
\nthe Loaded event before calling presentPaymentSheet().

createPaymentSheet(options: CreatePaymentSheetOption) => Promise<void>

\n\n\n

method presentPaymentSheet()

Presents the PaymentSheet created by createPaymentSheet() and resolves
\nwith its completed, canceled, or failed result.

presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetResultInterface; }>

\n\n\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

インターフェース

\n

PaymentSheet と PaymentFlow が継承するオプション

\n

CreatePaymentSheetOptionCreatePaymentFlowOption は、公開されている BasePaymentOption を拡張します。docgen のメタデータは継承フィールドを展開しないため、ここに明示します。

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
プロパティプラットフォーム/用途
defaultBillingDetailsDefaultBillingDetailsiOS、Android
shippingDetailsAddressDetailsAndroid
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationiOS、Android
customerEphemeralKeySecretstringcustomerId と併用
customerIdstringStripe Customer
enableApplePaybooleanネイティブ PaymentSheet
applePayMerchantIdstringApple Pay 有効時に必須
enableGooglePaybooleanネイティブ PaymentSheet
GooglePayIsTestingbooleanAndroid Google Pay テストモード
countryCodestringウォレットの国。既定値 US
merchantDisplayNamestringPaymentSheet の加盟店名
returnURLstringiOS のリダイレクト認証
paymentMethodLayout'horizontal' | 'vertical' | 'automatic'Android
style'alwaysLight' | 'alwaysDark'iOS
withZipCodebooleanWeb
currencyCodestringネイティブ SetupIntent の Google Pay
\n

すべて任意フィールドです。組み合わせと Web の制限は PaymentSheetPaymentFlowを参照してください。

\n

interface StripeInitializationOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key for the account that creates the client-side payment UI. Never pass a secret key to the client application.3.0.0
stripeAccountstringConnected account ID used when making client-side calls on behalf of a Stripe Connect account.3.0.0
\n\n

interface StripeURLHandlingOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
urlstringFull callback URL received by the application.4.0.0
\n\n

interface CreatePaymentSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreatePaymentFlowOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreateApplePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Apple Pay.3.1.0
paymentSummaryItemsPaymentSummaryItem[]Line items displayed in the Apple Pay sheet.3.1.0
merchantIdentifierstringApple merchant identifier configured for the app.3.1.0
countryCodestringTwo-letter ISO 3166-1 country code for the payment request.3.1.0
currencystringThree-letter ISO 4217 currency code for the payment request.3.1.0
requiredShippingContactFields('postalAddress' | 'phoneNumber' | 'emailAddress' | 'name')[]Shipping contact fields Apple Pay must collect. iOS only.4.1.0
allowedCountriesstring[]Two-letter country codes accepted for shipping. iOS only.5.4.3
allowedCountriesErrorDescriptionstringMessage shown when the selected shipping country is not allowed. iOS only.5.4.3
\n\n

interface CreateGooglePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Google Pay.3.2.0
paymentSummaryItems{ label: string; amount: number; }[]Web only. Requires stripe-pwa-elements ^3.0.0.3.2.0
merchantIdentifierstringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
countryCodestringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
currencystringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
\n\n

interface PaymentSummaryItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
labelstringLabel shown for the line item in the Apple Pay sheet.3.1.0
amountnumberDecimal amount in the currency's major unit, for example 10.99.3.1.0
\n\n

interface DefaultBillingDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailstringPrefilled billing email address.7.2.0
namestringPrefilled billing name.7.2.0
phonestringPrefilled billing phone number.7.2.0
addressAddressPrefilled billing address.7.2.0
\n\n

interface Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
countrystringTwo-letter country code (ISO 3166-1 alpha-2).7.2.0
citystringCity, district, suburb, town, or village.7.2.0
line1stringPrimary address line, such as a street address or post office box.7.2.0
line2stringSecondary address line, such as an apartment or suite.7.2.0
postalCodestringZIP or postal code.7.2.0
statestringState, county, province, or region.7.2.0
\n\n

interface AddressDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
namestringRecipient name.7.2.0
addressAddressRecipient postal address.7.2.0
phonestringRecipient phone number.7.2.0
isCheckboxSelectedbooleanWhether the customer selected the save-address checkbox. Android only.7.2.0
\n\n

interface BillingDetailsCollectionConfiguration

Controls which billing details PaymentSheet collects from the customer.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailCollectionModeEmail collection mode.5.4.0
nameCollectionModeName collection mode.5.4.0
phoneCollectionModePhone-number collection mode.5.4.0
addressAddressCollectionModePostal-address collection mode.5.4.0
\n\n\n

interface DidSelectShippingContact

Apple Pay shipping-contact data.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactShipping contact selected in Apple Pay.4.1.0
updateIdstringIdentifier passed to updateApplePaySheet() for this callback.4.1.0
\n\n\n

interface DidCreatePaymentMethod

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactContact attached to the Apple Pay payment method.4.1.0
\n\n

interface ShippingContact

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
givenNamestringContact's given name. Apple Pay only.4.1.0
familyNamestringContact's family name. Apple Pay only.4.1.0
middleNamestringContact's middle name. Apple Pay only.4.1.0
namePrefixstringContact's name prefix. Apple Pay only.4.1.0
nameSuffixstringContact's name suffix. Apple Pay only.4.1.0
nameFormattedstringContact's formatted full name. Apple Pay only.4.1.0
phoneNumberstringContact's phone number. Apple Pay only.4.1.0
nicknamestringContact's nickname. Apple Pay only.4.1.0
streetstringStreet component of the contact's postal address. Apple Pay only.4.1.0
citystringCity component of the contact's postal address. Apple Pay only.4.1.0
statestringState or province component of the contact's postal address. Apple Pay only.4.1.0
postalCodestringPostal-code component of the contact's address. Apple Pay only.4.1.0
countrystringCountry or region name in the contact's address. Apple Pay only.4.1.0
isoCountryCodestringISO country code in the contact's address. Apple Pay only.4.1.0
subAdministrativeAreastringSub-administrative area in the contact's address. Apple Pay only.4.1.0
subLocalitystringSublocality in the contact's address. Apple Pay only.4.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() =&gt; Promise&lt;void&gt;
\n\n

型エイリアス

\n

type alias PaymentSheetResultInterface

PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed

\n\n

type alias PaymentFlowResultInterface

PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed

\n\n

type alias ApplePayResultInterface

ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed | ApplePayEventsEnum.DidSelectShippingContact | ApplePayEventsEnum.DidCreatePaymentMethod

\n\n

type alias GooglePayResultInterface

GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed

\n\n

type alias CollectionMode

'automatic' | 'always' | 'never'

\n\n

type alias AddressCollectionMode

'automatic' | 'full' | 'never'

\n\n

列挙型

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'
\n\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'
\n\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'
\n\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'
\n\n
", + "html": "

@capacitor-community/stripe v8.2.1 の公開 API メタデータから生成したリファレンスです。プラットフォームの制限、継承されるオプションフィールド、結果リスナーのライフサイクル、サーバーの責務は各メソッドページで説明しています。

\n

メソッド

\n

method initialize(...)

Configures the Stripe SDK. Call this once before using any payment method.

initialize(opts: StripeInitializationOptions) => Promise<void>

\n\n\n

method handleURLCallback(...)

Passes an incoming return URL back to the Stripe SDK after redirect-based
\nauthentication.

iOS only. Call this from your app URL handler when Stripe redirects back
\nto the application.

handleURLCallback(opts: StripeURLHandlingOptions) => Promise<void>

\n\n\n\n

method isApplePayAvailable()

Resolves when Apple Pay is available and rejects when it is unavailable.
\nApple Pay is supported on iOS and compatible web browsers, not Android.

isApplePayAvailable() => Promise<void>

\n\n\n

method createApplePay(...)

Creates an Apple Pay request. Call this before presentApplePay().

createApplePay(options: CreateApplePayOption) => Promise<void>

\n\n\n

method presentApplePay()

Presents the Apple Pay request created by createApplePay().

presentApplePay() => Promise<{ paymentResult: ApplePayResultInterface; }>

\n\n\n

method updateApplePaySheet(...)

Updates the native Apple Pay sheet after a shipping-contact callback.
\niOS only; this method is not supported on web.

updateApplePaySheet(options: UpdateApplePaySheetOption) => Promise<void>

\n\n\n

method isGooglePayAvailable()

Resolves when Google Pay is available and rejects when it is unavailable.
\nGoogle Pay is supported on Android and compatible web browsers, not iOS.

isGooglePayAvailable() => Promise<void>

\n\n\n

method createGooglePay(...)

Creates a Google Pay request. Call this before presentGooglePay().

createGooglePay(options: CreateGooglePayOption) => Promise<void>

\n\n\n

method presentGooglePay()

Presents the Google Pay request created by createGooglePay().

presentGooglePay() => Promise<{ paymentResult: GooglePayResultInterface; }>

\n\n\n

method createPaymentFlow(...)

Creates a PaymentFlow instance. Use PaymentFlow when the app must collect
\npayment details first and confirm them in a later step.

createPaymentFlow(options: CreatePaymentFlowOption) => Promise<void>

\n\n\n

method presentPaymentFlow()

Presents the PaymentFlow created by createPaymentFlow() and resolves
\nwith the last four digits of the selected card.

presentPaymentFlow() => Promise<{ cardNumber: string; }>

\n\n\n

method confirmPaymentFlow()

Confirms the payment details collected by presentPaymentFlow().

confirmPaymentFlow() => Promise<{ paymentResult: PaymentFlowResultInterface; }>

\n\n\n

method createPaymentSheet(...)

Creates and configures a PaymentSheet instance. Wait for this Promise or
\nthe Loaded event before calling presentPaymentSheet().

createPaymentSheet(options: CreatePaymentSheetOption) => Promise<void>

\n\n\n

method presentPaymentSheet()

Presents the PaymentSheet created by createPaymentSheet() and resolves
\nwith its completed, canceled, or failed result.

presentPaymentSheet() => Promise<{ paymentResult: PaymentSheetResultInterface; }>

\n\n\n

method addListener(ApplePayEventsEnum.Loaded, ...)

Emitted when the Apple Pay request is ready to present.

addListener(eventName: ApplePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.FailedToLoad, ...)

Emitted when the Apple Pay request could not be created.

addListener(eventName: ApplePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Completed, ...)

Emitted after Apple Pay completes successfully.

addListener(eventName: ApplePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Apple Pay.

addListener(eventName: ApplePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.Failed, ...)

Emitted when Apple Pay fails.

addListener(eventName: ApplePayEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidSelectShippingContact, ...)

iOS only. Emitted when the customer selects a shipping contact. Use the
\nsupplied updateId with updateApplePaySheet().

addListener(eventName: ApplePayEventsEnum.DidSelectShippingContact, listenerFunc: (data: DidSelectShippingContact) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(ApplePayEventsEnum.DidCreatePaymentMethod, ...)

iOS only. Emitted after Apple Pay creates its Stripe PaymentMethod.

addListener(eventName: ApplePayEventsEnum.DidCreatePaymentMethod, listenerFunc: (data: DidCreatePaymentMethod) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Loaded, ...)

Emitted when the Google Pay request is ready to present.

addListener(eventName: GooglePayEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.FailedToLoad, ...)

Emitted when the Google Pay request could not be created.

addListener(eventName: GooglePayEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Completed, ...)

Emitted after Google Pay completes successfully.

addListener(eventName: GooglePayEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Canceled, ...)

Emitted when the customer cancels Google Pay.

addListener(eventName: GooglePayEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(GooglePayEventsEnum.Failed, ...)

Emitted when Google Pay fails.

addListener(eventName: GooglePayEventsEnum.Failed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Loaded, ...)

Emitted when PaymentFlow has been created and is ready to present.

addListener(eventName: PaymentFlowEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.FailedToLoad, ...)

Emitted when PaymentFlow could not be created.

addListener(eventName: PaymentFlowEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Opened, ...)

Emitted when the PaymentFlow UI is presented.

addListener(eventName: PaymentFlowEventsEnum.Opened, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Completed, ...)

Emitted after the collected payment details are confirmed.

addListener(eventName: PaymentFlowEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentFlow.

addListener(eventName: PaymentFlowEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Failed, ...)

Emitted when PaymentFlow collection or confirmation fails.

addListener(eventName: PaymentFlowEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentFlowEventsEnum.Created, ...)

Emitted after payment details are collected and before confirmation. The
\ncard number contains only the last four digits.

addListener(eventName: PaymentFlowEventsEnum.Created, listenerFunc: (info: { cardNumber: string; }) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Loaded, ...)

Emitted when PaymentSheet has been created and is ready to present.

addListener(eventName: PaymentSheetEventsEnum.Loaded, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.FailedToLoad, ...)

Emitted when PaymentSheet could not be created.

addListener(eventName: PaymentSheetEventsEnum.FailedToLoad, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Completed, ...)

Emitted after the customer completes PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Completed, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Canceled, ...)

Emitted when the customer dismisses PaymentSheet.

addListener(eventName: PaymentSheetEventsEnum.Canceled, listenerFunc: () => void) => Promise<PluginListenerHandle>

\n\n\n

method addListener(PaymentSheetEventsEnum.Failed, ...)

Emitted when PaymentSheet finishes with an error.

addListener(eventName: PaymentSheetEventsEnum.Failed, listenerFunc: (error: string) => void) => Promise<PluginListenerHandle>

\n\n\n

インターフェース

\n

PaymentSheet と PaymentFlow が継承するオプション

\n

CreatePaymentSheetOptionCreatePaymentFlowOption は、公開されている BasePaymentOption を拡張します。docgen のメタデータは継承フィールドを展開しないため、ここに明示します。

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
プロパティプラットフォーム/用途
defaultBillingDetailsDefaultBillingDetailsiOS、Android
shippingDetailsAddressDetailsAndroid
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationiOS、Android
customerEphemeralKeySecretstringcustomerId と併用
customerIdstringStripe Customer
enableApplePaybooleanネイティブ PaymentSheet
applePayMerchantIdstringApple Pay 有効時に必須
enableGooglePaybooleanネイティブ PaymentSheet
GooglePayIsTestingbooleanAndroid Google Pay テストモード
countryCodestringウォレットの国。既定値 US
merchantDisplayNamestringPaymentSheet の加盟店名
returnURLstringiOS のリダイレクト認証
paymentMethodLayout'horizontal' | 'vertical' | 'automatic'Android
style'alwaysLight' | 'alwaysDark'iOS
withZipCodebooleanWeb
currencyCodestringネイティブ SetupIntent の Google Pay
\n

すべて任意フィールドです。組み合わせと Web の制限は PaymentSheetPaymentFlowを参照してください。

\n

interface StripeInitializationOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
publishableKeystringStripe publishable key for the account that creates the client-side payment UI. Never pass a secret key to the client application.3.0.0
stripeAccountstringConnected account ID used when making client-side calls on behalf of a Stripe Connect account.3.0.0
\n\n

interface StripeURLHandlingOptions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
urlstringFull callback URL received by the application.4.0.0
\n\n

interface CreatePaymentSheetOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.0
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreatePaymentFlowOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionDefaultSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
setupIntentClientSecretstringClient secret of the SetupIntent used to save a payment method. Provide exactly one of paymentIntentClientSecret or setupIntentClientSecret.3.0.2
defaultBillingDetailsDefaultBillingDetailsBilling details used to prefill PaymentSheet. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#set-default-billing-details7.2.0
shippingDetailsAddressDetailsShipping details used to prefill PaymentSheet. Android only; on iOS use Stripe's address element instead. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=android#prefill-addresses7.2.0
billingDetailsCollectionConfigurationBillingDetailsCollectionConfigurationControls which billing details PaymentSheet collects. iOS and Android only. https://docs.stripe.com/payments/mobile/collect-addresses?payment-ui=mobile&platform=ios#customize-billing-details-collection7.2.0
customerEphemeralKeySecretstringCustomer ephemeral-key secret returned by your server. Use together with customerId; do not provide only one of the pair.3.0.0
customerIdstringStripe Customer ID associated with customerEphemeralKeySecret.3.0.0
enableApplePaybooleanEnables Apple Pay in native PaymentSheet. iOS only.false3.3.0
applePayMerchantIdstringApple merchant identifier configured for the app. Required when enableApplePay is true and ignored otherwise.3.3.0
enableGooglePaybooleanEnables Google Pay in native PaymentSheet. Android only.false3.2.0
GooglePayIsTestingbooleanUses the Google Pay test environment. Android only.false3.2.0
countryCodestringTwo-letter ISO 3166-1 country code used by Apple Pay or Google Pay. Ignored when neither wallet is enabled.\"US\"3.2.0
merchantDisplayNamestringMerchant name displayed in native PaymentSheet.\"App Name\"3.0.0
returnURLstringCustom URL scheme used to return to the app after redirect-based authentication. iOS only.\"\"3.0.0
paymentMethodLayout'automatic' | 'horizontal' | 'vertical'Layout used to display payment methods in PaymentSheet on iOS and Android.\"automatic\"7.2.2
style'alwaysLight' | 'alwaysDark'Appearance override for native PaymentSheet. iOS only.undefined3.0.0
withZipCodebooleanShows the ZIP-code field in the web card form. Web only.true3.6.0
currencyCodestringThree-letter ISO 4217 currency code used by Google Pay. Required when Google Pay is enabled for a SetupIntent.\"USD\"7.1.0
\n\n

interface CreateApplePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Apple Pay.3.1.0
paymentSummaryItemsPaymentSummaryItem[]Line items displayed in the Apple Pay sheet.3.1.0
merchantIdentifierstringApple merchant identifier configured for the app.3.1.0
countryCodestringTwo-letter ISO 3166-1 country code for the payment request.3.1.0
currencystringThree-letter ISO 4217 currency code for the payment request.3.1.0
requiredShippingContactFields('postalAddress' | 'phoneNumber' | 'emailAddress' | 'name')[]Shipping contact fields Apple Pay must collect. iOS only.4.1.0
allowedCountriesstring[]Two-letter country codes accepted for shipping. iOS only.5.4.3
allowedCountriesErrorDescriptionstringMessage shown when the selected shipping country is not allowed. iOS only.5.4.3
\n\n

interface CreateGooglePayOption

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
paymentIntentClientSecretstringClient secret of the PaymentIntent to confirm with Google Pay.3.2.0
paymentSummaryItems{ label: string; amount: number; }[]Web only. Requires stripe-pwa-elements ^3.0.0.3.2.0
merchantIdentifierstringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
countryCodestringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
currencystringWeb only. Requires stripe-pwa-elements ^3.0.0.3.2.0
\n\n

interface PaymentSummaryItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
labelstringLabel shown for the line item in the Apple Pay sheet.3.1.0
amountnumberDecimal amount in the currency's major unit, for example 10.99.3.1.0
\n\n

interface DefaultBillingDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailstringPrefilled billing email address.7.2.0
namestringPrefilled billing name.7.2.0
phonestringPrefilled billing phone number.7.2.0
addressAddressPrefilled billing address.7.2.0
\n\n

interface Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
countrystringTwo-letter country code (ISO 3166-1 alpha-2).7.2.0
citystringCity, district, suburb, town, or village.7.2.0
line1stringPrimary address line, such as a street address or post office box.7.2.0
line2stringSecondary address line, such as an apartment or suite.7.2.0
postalCodestringZIP or postal code.7.2.0
statestringState, county, province, or region.7.2.0
\n\n

interface AddressDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
namestringRecipient name.7.2.0
addressAddressRecipient postal address.7.2.0
phonestringRecipient phone number.7.2.0
isCheckboxSelectedbooleanWhether the customer selected the save-address checkbox. Android only.7.2.0
\n\n

interface BillingDetailsCollectionConfiguration

Controls which billing details PaymentSheet collects from the customer.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
emailCollectionModeEmail collection mode.5.4.0
nameCollectionModeName collection mode.5.4.0
phoneCollectionModePhone-number collection mode.5.4.0
addressAddressCollectionModePostal-address collection mode.5.4.0
\n\n\n

interface DidSelectShippingContact

Apple Pay shipping-contact data.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactShipping contact selected in Apple Pay.4.1.0
updateIdstringIdentifier passed to updateApplePaySheet() for this callback.4.1.0
\n\n\n

interface DidCreatePaymentMethod

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
contactShippingContactContact attached to the Apple Pay payment method.4.1.0
\n\n

interface ShippingContact

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropTypeDescriptionSince
givenNamestringContact's given name. Apple Pay only.4.1.0
familyNamestringContact's family name. Apple Pay only.4.1.0
middleNamestringContact's middle name. Apple Pay only.4.1.0
namePrefixstringContact's name prefix. Apple Pay only.4.1.0
nameSuffixstringContact's name suffix. Apple Pay only.4.1.0
nameFormattedstringContact's formatted full name. Apple Pay only.4.1.0
phoneNumberstringContact's phone number. Apple Pay only.4.1.0
nicknamestringContact's nickname. Apple Pay only.4.1.0
streetstringStreet component of the contact's postal address. Apple Pay only.4.1.0
citystringCity component of the contact's postal address. Apple Pay only.4.1.0
statestringState or province component of the contact's postal address. Apple Pay only.4.1.0
postalCodestringPostal-code component of the contact's address. Apple Pay only.4.1.0
countrystringCountry or region name in the contact's address. Apple Pay only.4.1.0
isoCountryCodestringISO country code in the contact's address. Apple Pay only.4.1.0
subAdministrativeAreastringSub-administrative area in the contact's address. Apple Pay only.4.1.0
subLocalitystringSublocality in the contact's address. Apple Pay only.4.1.0
\n\n

interface PluginListenerHandle

\n\n\n\n\n\n\n\n\n\n\n\n\n
PropType
remove() => Promise<void>
\n\n

型エイリアス

\n

type alias PaymentSheetResultInterface

PaymentSheetEventsEnum.Completed | PaymentSheetEventsEnum.Canceled | PaymentSheetEventsEnum.Failed

\n\n

type alias PaymentFlowResultInterface

PaymentFlowEventsEnum.Completed | PaymentFlowEventsEnum.Canceled | PaymentFlowEventsEnum.Failed

\n\n

type alias ApplePayResultInterface

ApplePayEventsEnum.Completed | ApplePayEventsEnum.Canceled | ApplePayEventsEnum.Failed | ApplePayEventsEnum.DidSelectShippingContact | ApplePayEventsEnum.DidCreatePaymentMethod

\n\n

type alias GooglePayResultInterface

GooglePayEventsEnum.Completed | GooglePayEventsEnum.Canceled | GooglePayEventsEnum.Failed

\n\n

type alias CollectionMode

'automatic' | 'always' | 'never'

\n\n

type alias AddressCollectionMode

'automatic' | 'full' | 'never'

\n\n

列挙型

\n

enum PaymentSheetEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentSheetLoaded'
FailedToLoad'paymentSheetFailedToLoad'
Completed'paymentSheetCompleted'
Canceled'paymentSheetCanceled'
Failed'paymentSheetFailed'
\n\n

enum PaymentFlowEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'paymentFlowLoaded'
FailedToLoad'paymentFlowFailedToLoad'
Opened'paymentFlowOpened'
Created'paymentFlowCreated'
Completed'paymentFlowCompleted'
Canceled'paymentFlowCanceled'
Failed'paymentFlowFailed'
\n\n

enum ApplePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'applePayLoaded'
FailedToLoad'applePayFailedToLoad'
Completed'applePayCompleted'
Canceled'applePayCanceled'
Failed'applePayFailed'
DidSelectShippingContact'applePayDidSelectShippingContact'
DidCreatePaymentMethod'applePayDidCreatePaymentMethod'
\n\n

enum GooglePayEventsEnum

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MemberValue
Loaded'googlePayLoaded'
FailedToLoad'googlePayFailedToLoad'
Completed'googlePayCompleted'
Canceled'googlePayCanceled'
Failed'googlePayFailed'
\n\n
", "headings": [ { "id": "%E3%83%A1%E3%82%BD%E3%83%83%E3%83%89", diff --git a/scripts/generate-docs.ts b/scripts/generate-docs.ts index af3d4a8..6792ec2 100644 --- a/scripts/generate-docs.ts +++ b/scripts/generate-docs.ts @@ -36,7 +36,13 @@ import { const root = resolve(process.cwd()); const docsRepositoryUrl = 'https://github.com/rdlabo-dev/website'; -const stripHtml = (value: string) => value.replace(/<\/?code>/g, '`').replace(/<[^>]+>/g, ''); +function stripHtml(value: string): string { + const fragment = JSDOM.fragment(value); + for (const code of fragment.querySelectorAll('code')) { + code.replaceWith(`\`${code.textContent ?? ''}\``); + } + return fragment.textContent ?? ''; +} const tagText = (tags: any[], name: string) => tags?.find((tag) => tag.name === name)?.text ?? ''; function apiMarkdown(source: any): Map {