Hyvä Checkout
Hyvä Checkout is a stand-alone commercial product
A separate license is required to use Hyvä Checkout. Visit hyva.io for pricing and licensing details.
Hyvä Checkout is the native checkout solution for Hyvä Themes, built for deep integration and easy customization. Because Hyvä Checkout can be scoped to specific store views, you can roll it out gradually, keeping other checkout solutions in place on store views where Hyvä Checkout is not yet active.
Ready to install it? Continue to Installing Hyvä Checkout.
Two release lines: Checkout 3.x and Checkout 1.x
Hyvä Checkout 3.x is the current release line and runs on Magewire 3. Checkout 1.x is the previous line and runs on Magewire 1. Code written for Checkout 1.x keeps working on Checkout 3.x through the v1bc module, which Checkout 3.x installs. Wherever the two lines differ, these docs show version tabs. Release Lines and Magewire Versions sums up what you need to know for a store on Checkout 3.x and for an extension that supports both lines.
Where to Start with Hyvä Checkout
Hyvä Checkout is built on Magewire, a server-driven PHP component framework, so there's a bit of background to pick up before you write your first checkout component. This reading path gets you productive quickly:
- Install Hyvä Checkout and enable it for a store view.
- Check your release line and what it means for your store or extension.
- Read the Quickstart for the core concepts, architecture pillars and file conventions.
- Learn the Magewire basics you need for checkout components.
- Pick the guide for your task from the overview below.
Hyvä Checkout Documentation Overview
The Hyvä Checkout documentation is organized by task. Pick the area that matches what you're building.
-
Getting Started
Requirements, installation with a license key or as a partner, and the admin settings that switch a store view to Hyvä Checkout.
-
Magewire in Hyvä Checkout
The component framework behind every checkout step: components, templates, events, lifecycle hooks, and how Magewire works with Alpine.js.
-
Custom Checkouts and Steps
Define checkouts and steps in
hyva_checkout.xml, place components with layout handles, and control when steps are available. -
Forms and Address Fields
Customize the shipping, billing and guest forms with the Form API: add fields, set attributes and values, and make fields depend on each other.
-
Evaluation API
Validate checkout data on the server and tell the frontend what to do next, from blocking navigation to showing messages.
-
Integration Development
Build reusable payment, shipping and address finder integrations, control how orders are placed, and support Checkout 1.x and 3.x with one codebase.
-
Frontend JavaScript API
The
hyvaCheckoutJavaScript namespace for payment, storage, validation, evaluation and checkout events. -
Content Security Policy
Run Hyvä Checkout under a strict CSP, register inline scripts, and make theme components CSP compatible.
-
Existing Integrations
Payment, shipping and address finder modules that already support Hyvä Checkout, plus community extensions.
-
FAQ
Answers to common questions and errors, from two-column layouts to missing totals.
Using Hyvä Checkout on a Luma Store
Hyvä Checkout can run on stores that use a Luma theme, so it doesn't require a full Hyvä Themes setup. See the Hyvä Checkout FAQ for setup instructions.
A/B Testing Hyvä Checkout Performance
When introducing Hyvä Checkout to an existing store, it's useful to measure how the new checkout performs compared to the existing Luma-based checkout. Elgentos published an open source Magento 2 module for this purpose: elgentos/magento2-hyva-checkout-ab-test.
The module is quick to set up. Keep in mind that a large data set is needed to get statistically meaningful A/B test results.
Support
Post questions to an appropriate channel in the Hyvä Slack. License holders can also submit technical support requests through the technical support form in the Hyvä customer portal.