|
1 | 1 | # Checkout Kit |
| 2 | + |
| 3 | +[](LICENSE) |
| 4 | + |
| 5 | +<img width="3200" height="800" alt="gradients" src="https://github.com/user-attachments/assets/72813286-1bec-493b-b08a-6cc4ba23dbda" /> |
| 6 | + |
| 7 | +Shopify's **Checkout Kit** lets native mobile apps embed Shopify's one-page checkout while preserving every store customization — Checkout UI extensions, Functions, Web Pixels, branding — and staying idiomatic to the host platform (light/dark mode, lifecycle hooks, native APIs to embed and customize the experience). |
| 8 | + |
| 9 | +## Documentation |
| 10 | + |
| 11 | +The [Checkout Kit dev docs](https://shopify.dev/docs/storefronts/mobile/checkout-kit) are the canonical reference — overview, platform install steps, and per-topic guides all live there. |
| 12 | + |
| 13 | +Feature guides: |
| 14 | + |
| 15 | +- [Preload checkout](https://shopify.dev/docs/storefronts/mobile/checkout-kit/preloading) — fetch checkout in the background so it's ready when buyers are. |
| 16 | +- [Monitor the checkout lifecycle](https://shopify.dev/docs/storefronts/mobile/checkout-kit/monitor-checkout-lifecycle) — handle completion, failure, and cancellation events. |
| 17 | +- [Authenticate checkouts](https://shopify.dev/docs/storefronts/mobile/checkout-kit/authenticate-checkouts) — sign buyers in to prefill saved addresses and payment methods. |
| 18 | +- [Privacy compliance](https://shopify.dev/docs/storefronts/mobile/checkout-kit/privacy-compliance) — pass GDPR, CCPA, and ATT consent through to Shopify. |
| 19 | +- [Accelerated checkouts](https://shopify.dev/docs/storefronts/mobile/checkout-kit/accelerated-checkouts-overview) — Shop Pay and Apple Pay buttons for one-tap purchase on product and cart pages. |
| 20 | + |
| 21 | +## Platforms |
| 22 | + |
| 23 | +Each platform ships from its own subdirectory with a dedicated README covering installation, configuration, and the full API. We expect overlap between these READMEs to migrate up here (and into the dev docs) over time — for now, treat the per-platform READMEs as the source of truth. |
| 24 | + |
| 25 | +- **[Swift / iOS](swift/README.md)** — Swift Package and CocoaPods |
| 26 | +- **[Android](android/README.md)** — published to Maven Central as `com.shopify:checkout-kit` |
| 27 | +- **[React Native](react-native/README.md)** — placeholder; wrapper will be folded in soon |
| 28 | +- **[End-to-end tests](e2e/README.md)** — placeholder; cross-platform E2E suite incoming |
| 29 | + |
| 30 | +## Repository layout |
| 31 | + |
| 32 | +``` |
| 33 | +swift/ # iOS / Swift Package |
| 34 | +android/ # Android library and sample apps |
| 35 | +react-native/ # React Native wrapper (incoming) |
| 36 | +e2e/ # cross-platform end-to-end tests (incoming) |
| 37 | +.github/ # workflows, issue templates, CODEOWNERS |
| 38 | +``` |
| 39 | + |
| 40 | +## Contributing |
| 41 | + |
| 42 | +Issues and pull requests are welcome. See [CONTRIBUTING](.github/CONTRIBUTING.md) and our [Code of Conduct](.github/CODE_OF_CONDUCT.md). |
| 43 | + |
| 44 | +## License |
| 45 | + |
| 46 | +[MIT](LICENSE) |
0 commit comments