encora / theme-sdk
Contracts and data objects for building Encora frontend themes.
Requires
- php: ^8.3
Requires (Dev)
- pestphp/pest: ^3.8
This package is auto-updated.
Last update: 2026-08-14 10:57:43 UTC
README
The public contract package for developer-built Encora frontend themes.
Themes are trusted Composer packages. They describe which canonical Encora pages they render and receive host-supplied data transfer objects (DTOs), rather than accessing Encora's private Eloquent models or authorization services.
Installation
composer require encora/theme-sdk
Status
This package contains no private Encora application code. The host maps its protected routes, actions, and authorization to these public contracts; a theme only receives stable, safe DTOs.
Start a theme locally
- Copy
examples/midnight-themeinto a new Composer package. - Rename the PHP namespace, package name, theme identifier, and view namespace.
- Test the package with the SDK's synthetic fixtures.
- Submit the package to Encora staff for technical review and installation as an author-only preview.
Read the authoring guide, the complete data reference, contract reference, local development guide, and the private host integration contract.