fcakyon/claude-codex-settings / plugins/stripe-skills/skills/stripe-apps
stripe-apps
VerifiedBuild, modify, or review Stripe Apps and extensions using the relevant documentation and reference guides. Use for custom Stripe Dashboard UI, stripe-app.yaml, @stripe/ui-extension-sdk, @stripe/extensibility-sdk, script extensions, extension interfaces, custom workflow actions, and apps that authenticate to Stripe or react to events. Also use when deciding whether a Stripe extension can support the user's billing or workflow requirements.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 7.6 KB |
| references/authentication.md | markdown | 4.6 KB |
| references/backend.md | markdown | 4.4 KB |
| references/canonical-docs.md | markdown | 4.4 KB |
| references/discovery.md | markdown | 9.2 KB |
| references/extension-types.md | markdown | 5.1 KB |
| references/feedback.md | markdown | 1.9 KB |
| references/onboarding-ux.md | markdown | 2.7 KB |
| references/publishing.md | markdown | 5.7 KB |
| references/script-extensions.md | markdown | 7.3 KB |
| references/ui-extensions.md | markdown | 20.7 KB |
| references/webhooks.md | markdown | 3.4 KB |
| references/workflow.md | markdown | 8.5 KB |
references/onboarding-ux.md
View on GitHub# Onboarding UX — first-run user experience
## Onboarding UX
**Plain-language:** “When someone installs your app for the first time, the first thing they see is your app’s welcome or setup screen. This is called onboarding.”
Design this experience carefully — it determines whether merchants understand how to use your app or give up immediately.
**Canonical page:** https://docs.stripe.com/stripe-apps/patterns/onboarding-experience
Read this page using an available documentation tool for the correct component props and patterns.
## Options from simplest to most complex
### Option 1 — Zero-touch onboarding (easiest)
If your app only uses Stripe data and doesn’t need its own login, there’s nothing to set up. The app works immediately after install.
Use `fetchStripeSignature` to identify the user without a login screen — the user’s Stripe identity proves who they are.
**When to use:** When your app doesn’t need third-party credentials or a separate user account.
### Option 2 — OnboardingView component
Show a setup screen the first time the user opens the app. Use the `onboarding` viewport to show a dedicated onboarding page.
In `stripe-app.yaml`, add the `onboarding` viewport:
```yaml
ui_extension:
views:
- viewport: onboarding
component: OnboardingView
- viewport: stripe.dashboard.customer.detail
component: App
```
For the correct `OnboardingView` component props and structure, read the canonical onboarding page. Key requirements:
- Use the `OnboardingView` component (not `ContextView`) for the onboarding viewport
- Include required props like `completed`, `tasks`, and `title`
### Option 3 — SignInView component (third-party login)
If users need to log in to a third-party service (connecting their Google account, Mailchimp, etc.), use `SignInView` to guide them.
For the correct `SignInView` props and usage, read: https://docs.stripe.com/stripe-apps/patterns/onboarding-experience
Use the Secret Store API to save the resulting OAuth token. See `backend.md`.
## Critical rule: always check onboarding status in every view
Don’t assume the user went through the onboarding flow in order. They might open a payment page before completing setup.
Check at the start of every page-specific view whether onboarding is complete. If not, show a prompt directing them to complete setup.
## Storing onboarding state
Use the Secret Store API to remember whether a user has completed onboarding.
For the correct Secret Store API patterns, read: https://docs.stripe.com/stripe-apps/store-secrets
Key facts:
- Use `user` scope for per-user onboarding state
- Use `account` scope for account-wide configuration
- Maximum 10 secrets per scope
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation). | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK). | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |