# Hyva Documentation

> Hyva Themes is a high-performance Magento 2 frontend built with Tailwind CSS and Alpine.js, replacing Luma's RequireJS, Knockout.js, and Less CSS stack.

Hyva offers a suite of products for Magento 2: a frontend theme, a headless-ready checkout, an enterprise commerce bundle, a component UI library, a CMS widget system, and an admin grid framework. All products are installed via Composer and licensed through the Hyva portal at hyva.io.

**Licensing:** All Hyva Theme packages are publicly available on GitHub (see below). Other Hyva products (Checkout, Commerce, Enterprise, UI Library, Widgets) require a paid license and are distributed via a private Composer repository.

## Getting Started

- [What is Hyva?](https://docs.hyva.io/welcome/what-is-hyva.html): Overview of the Hyva product family and its goals.
- [Installation](https://docs.hyva.io/hyva-themes/getting-started/index.html): How to install the Hyva theme via Composer using a packagist.com license key.
- [Technical Vision](https://docs.hyva.io/welcome/technical-vision.html): The architectural philosophy behind Hyva.
- [Support](https://docs.hyva.io/welcome/support.html): Support channels including the Hyva Slack community.

## Hyva Theme

The core frontend theme. Uses phtml templates, layout XML, Tailwind CSS, and Alpine.js — no RequireJS, Knockout, or Less. All packages listed below are free and publicly available on GitHub.

- [Building Your Theme](https://docs.hyva.io/hyva-themes/building-your-theme/index.html): Creating a child theme on top of the Hyva default theme.
- [Working with Tailwind CSS](https://docs.hyva.io/hyva-themes/working-with-tailwindcss/index.html): Tailwind CSS configuration, purging, and customization.
- [Working with Alpine.js](https://docs.hyva.io/hyva-themes/working-with-alpinejs/index.html): How Alpine.js replaces Knockout and RequireJS for frontend interactivity.
- [x-snap-slider](https://docs.hyva.io/hyva-themes/working-with-alpinejs/alpine-plugins/x-snap-slider.html): Built-in Alpine.js slider plugin using CSS scroll snap.
- [x-htmldialog](https://docs.hyva.io/hyva-themes/working-with-alpinejs/alpine-plugins/x-htmldialog.html): Built-in Alpine.js plugin for native HTML `<dialog>` element modals and dialogs.
- [Writing Code](https://docs.hyva.io/hyva-themes/writing-code/index.html): Blocks, view models, phtml templates, layout XML, and JavaScript patterns.
- [View Utilities](https://docs.hyva.io/hyva-themes/view-utilities/index.html): Helper classes and utilities available in templates (e.g. `$hyva`, SVG icons).
- [Product Sliders](https://docs.hyva.io/hyva-themes/view-utilities/product-sliders.html): Built-in product slider components available in Hyva templates.
- [Custom Sliders](https://docs.hyva.io/hyva-themes/view-utilities/custom-sliders.html): How to build custom sliders in Hyva.
- [Modal Dialogs](https://docs.hyva.io/hyva-themes/view-utilities/modal-dialogs/index.html): Overview of Hyva's modal dialog system using the modal view model.
- [Compatibility Modules](https://docs.hyva.io/hyva-themes/compatibility-modules/index.html): How to make third-party Luma modules work with Hyva.
- [Luma Theme Fallback](https://docs.hyva.io/hyva-themes/luma-theme-fallback/index.html): Falling back to Luma for unsupported pages.
- [Advanced Topics](https://docs.hyva.io/hyva-themes/advanced-topics/index.html): CSP, email styling, performance, and other advanced configuration.
- [Content Security Policy (CSP)](https://docs.hyva.io/hyva-themes/writing-code/csp/index.html): Overview of CSP requirements for Hyva themes, PCI-DSS 4.0 compliance, and implementation strategies.
- [CSP Compatibility](https://docs.hyva.io/hyva-themes/writing-code/csp/csp-compatibility.html): How Hyva handles `unsafe-eval` (Alpine CSP build) and `unsafe-inline` (`$hyvaCsp->registerInlineScript()`).
- [Alpine CSP](https://docs.hyva.io/hyva-themes/writing-code/csp/alpine-csp.html): Differences between standard Alpine.js and the Alpine CSP build, with migration examples.
- [Alpine CSP Example Component](https://docs.hyva.io/hyva-themes/writing-code/csp/alpine-csp-example-component.html): A complete CSP-compatible Alpine component showing correct patterns.
- [CSP Installation (Hyva Default Theme CSP)](https://docs.hyva.io/hyva-themes/writing-code/csp/hyva-default-theme-csp-installation.html): How to install the strict CSP-compatible variant of the Hyva default theme.
- [Upgrading](https://docs.hyva.io/hyva-themes/upgrading/index.html): Changelog and upgrade guides for the Hyva theme.
- [FAQs](https://docs.hyva.io/hyva-themes/faqs/index.html): Frequently asked questions and troubleshooting.

### Core Theme Packages (GitHub)

Installed via `composer require hyva-themes/magento2-default-theme`.

- [magento2-default-theme](https://github.com/hyva-themes/magento2-default-theme): The Hyva default theme — phtml templates, Tailwind config, Alpine.js components.
- [magento2-theme-module](https://github.com/hyva-themes/magento2-theme-module): Companion Magento module — PHP helpers, view models, events, GraphQL queries.
- [magento2-base-layout-reset](https://github.com/hyva-themes/magento2-base-layout-reset): Generates the Hyva base layout reset to remove Luma's layout handles.
- [magento2-email-module](https://github.com/hyva-themes/magento2-email-module): Email rendering support for Hyva-based themes with Blank theme fallback.
- [magento2-compat-module-fallback](https://github.com/hyva-themes/magento2-compat-module-fallback): Allows templates to be overridden by Hyva compatibility modules without layout XML.
- [magento2-order-cancellation-webapi](https://github.com/hyva-themes/magento2-order-cancellation-webapi): WebAPI endpoint for order cancellation used by the theme.
- [magento2-graphql-tokens](https://github.com/hyva-themes/magento2-graphql-tokens): Adds customer and cart tokens to CustomerData sections for GraphQL use.
- [magento2-graphql-view-model](https://github.com/hyva-themes/magento2-graphql-view-model): View model for customizing GraphQL queries and mutations in Hyva templates.

### Theme Add-ons & Extensions (GitHub)

Additional public packages that extend the core theme.

- [magento2-default-theme-csp](https://github.com/hyva-themes/magento2-default-theme-csp): A strict Content Security Policy (CSP) compatible variant of the default theme.
- [magento2-theme-fallback](https://github.com/hyva-themes/magento2-theme-fallback): Enables falling back to Luma or another Magento theme on specific routes.
- [magento2-luma-checkout](https://github.com/hyva-themes/magento2-luma-checkout): Luma-based checkout fallback for use with the Hyva theme.
- [magento2-wysiwyg-svg](https://github.com/hyva-themes/magento2-wysiwyg-svg): Allows SVG images in Magento CMS blocks and pages via TinyMCE.
- [magento2-mollie-theme-bundle](https://github.com/hyva-themes/magento2-mollie-theme-bundle): Hyva compatibility bundle for Mollie payment methods.
- [magento2-optimized-csp-allowlist](https://github.com/hyva-themes/magento2-optimized-csp-allowlist): Includes only domains from `csp_whitelist.xml` that are actually used in CSP headers.
- [hyva-modules-tailwind-js](https://github.com/hyva-themes/hyva-modules-tailwind-js): Tailwind CSS utility functions for Hyva modules.

### Payment Integrations (GitHub)

- [adyen-magento2-hyva](https://github.com/hyva-themes/adyen-magento2-hyva): Adyen payment support via Hyva Checkout for Magento 2.

## Hyva Admin

A framework for building Magento admin grids and forms — no UI components required. Publicly available on GitHub.

- [Overview](https://docs.hyva.io/hyva-admin/index.html): What Hyva Admin is and when to use it.
- [magento2-hyva-admin](https://github.com/hyva-themes/magento2-hyva-admin): The Hyva Admin module for fast, joyful grid and form creation in the Magento adminhtml area.
- [hyva-admin-test-module](https://github.com/hyva-themes/hyva-admin-test-module): A test/example module demonstrating Hyva Admin usage.

## Hyva Checkout

A Magewire-powered checkout for Magento 2. Fully server-rendered, no React or Vue required. **Requires a paid license.**

- [Overview](https://docs.hyva.io/hyva-checkout/index.html): What Hyva Checkout is and how it differs from Luma and React Checkout.
- [Quickstart](https://docs.hyva.io/hyva-checkout/getting-started/quickstart.html): Installation and setup guide.
- [Custom Checkout](https://docs.hyva.io/hyva-checkout/devdocs/custom-checkout/hyva-checkout-xml.html): Customizing the checkout structure with `hyva-checkout.xml`.
- [Magewire Components](https://docs.hyva.io/hyva-checkout/magewire/index.html): Using Magewire for server-driven UI in the checkout.
- [Form Customization](https://docs.hyva.io/hyva-checkout/devdocs/form-customization/index.html): Modifying checkout address and payment forms.
- [Payment Integration](https://docs.hyva.io/hyva-checkout/devdocs/payments/payment-in-hyva-checkout.html): How payments work and how to integrate payment methods.
- [Shipping Integration](https://docs.hyva.io/hyva-checkout/devdocs/shipping/shipping-integration-api.html): Shipping method integration API.
- [Frontend API](https://docs.hyva.io/hyva-checkout/devdocs/frontend-api/index.html): JavaScript API for checkout events and state.
- [CSP](https://docs.hyva.io/hyva-checkout/devdocs/csp/index.html): Content Security Policy support in Hyva Checkout.
- [Available Payment Methods](https://docs.hyva.io/hyva-checkout/integrations/available-payment-methods.html): List of payment methods with Hyva Checkout support.

## Hyva Commerce

An enterprise-ready bundle combining the Hyva theme with additional admin and storefront features. **Requires a paid license.**

- [About Hyva Commerce](https://docs.hyva.io/hyva-commerce/index.html): Overview and feature list.
- [Getting Started](https://docs.hyva.io/hyva-commerce/getting-started/index.html): Installation and setup.
- [Upgrading](https://docs.hyva.io/hyva-commerce/upgrading/index.html): Changelog and upgrade instructions.

## Hyva UI Library

A library of pre-built, accessible, Tailwind-styled UI components for Hyva themes. **Requires a paid license.**

- [What is the Hyva UI Library?](https://docs.hyva.io/hyva-ui-library/what-is-the-hyva-ui-library.html): Overview of the component library.
- [Included Components](https://docs.hyva.io/hyva-ui-library/included-components.html): Full list of available components.

## Hyva Widgets

A CMS widget and page builder system for Hyva themes. **Requires a paid license.**

- [Introduction](https://docs.hyva.io/hyva-widgets/introduction-video.html): Overview of the Hyva Widgets system.

## Hyva Enterprise

Extensions and integrations for Adobe Commerce / Magento Enterprise features (Live Search, Product Recommendations, B2B). **Requires a paid license.**

- [Overview](https://docs.hyva.io/hyva-enterprise/index.html): Enterprise-specific features.

## AI Developer Tooling

Tools to help AI coding assistants work effectively with Hyva. All packages publicly available on GitHub.

- [Hyva AI Skills](https://docs.hyva.io/hyva-themes/ai/developer-tooling/skills/index.html): AI skills (for Claude, Cursor, Copilot, etc.) that provide Hyva-specific coding knowledge.
- [AI Providers & Framework](https://docs.hyva.io/hyva-themes/ai/features-providers/index.html): Provider-agnostic framework for adding AI-powered features (OpenAI, Gemini, DeepL) to Hyva modules.
- [AI Integration Guide](https://docs.hyva.io/hyva-themes/ai/features-providers/integration-guide.html): How to create handlers and integrate custom AI providers using the Hyva AI framework.
- [hyva-ai-tools](https://github.com/hyva-themes/hyva-ai-tools): AI skill files and resources for Hyva development.
- [magento2-module-ai](https://github.com/hyva-themes/magento2-module-ai): Base AI framework module.
- [magento2-ai-providers](https://github.com/hyva-themes/magento2-ai-providers): Metapackage for all Hyva AI providers.
- [magento2-module-ai-open-ai](https://github.com/hyva-themes/magento2-module-ai-open-ai): OpenAI (ChatGPT) provider implementation.
- [magento2-module-ai-gemini](https://github.com/hyva-themes/magento2-module-ai-gemini): Google Gemini provider implementation.
- [magento2-module-ai-deep-l](https://github.com/hyva-themes/magento2-module-ai-deep-l): DeepL translation provider implementation.

## Developer Tools (GitHub)

- [hyva-coding-standard](https://github.com/hyva-themes/hyva-coding-standard): Hyva-specific PHP CodeSniffer rules extending the Magento Coding Standard.
- [magento2-i18n-csv-diff](https://github.com/hyva-themes/magento2-i18n-csv-diff): Magento commands to find missing translations between CSV files and translate with DeepL.