symfinity / ux-blocks
Registry schema and shared test helpers for the Symfinity UX Blocks component family
Maintainers
Fund package maintenance!
Requires
- php: >=8.2
- symfony/config: ^7.4||^8.0
- symfony/console: ^7.4||^8.0
- symfony/dependency-injection: ^7.4||^8.0
- symfony/framework-bundle: ^7.4||^8.0
- symfony/http-kernel: ^7.4||^8.0
- symfony/process: ^7.4||^8.0
- symfony/yaml: ^7.4||^8.0
Requires (Dev)
- phpstan/phpstan: ^2.1
- phpstan/phpstan-symfony: ^2.0
- phpunit/phpunit: ^10.5 || ^11.0
Suggests
- symfinity/ui-action: Native HTTP action semantics for interactive blocks
- symfinity/ui-kernel: Token-driven role CSS and flavours when building styled blocks
- symfony/ux-icons: Icon set for roles that use ux:icon (optional per app)
README
UX Blocks
Registry schema and shared test helpers for the Symfinity UX Blocks component family
Note
Read-only mirror. See CONTRIBUTING.md for how to propose changes.
Features
- Registry schema — shared
data-ui-roleand fragment vocabulary across tier packages - Tier role catalogs — canonical role lists for core, extended, interactive, and vertical packages
- PHPUnit helpers — markup assertions for component packages in dev and test
- Slim SDK boundary — Twig components ship in
symfinity/ux-blocks-*packages - Symfony Flex recipe — bundle registered for all environments
Prerequisites
Add the symfinity/recipes Flex endpoint to your project's composer.json (see recipes README) — recipes are not in Symfony's official recipe repository yet.
Installation
composer require symfinity/ux-blocks
Usually installed as a dependency of a tier package. See Installation.
Quick Start
composer require symfinity/ux-blocks-core
<twig:PageHeading title="Dashboard" description="Welcome back." /> <twig:Button variant="default">Save</twig:Button>
See Quick start for PHPUnit markup assertions and tier pairing.
Install profiles
Pick the smallest profile that fits your app. See Install profiles in the handbook.
Full app UI — one line for the complete official catalog (core, form, extended, interactive, live):
composer require symfinity/ux-blocks-full
See Installation for headless, kernel-styled, and vertical tier choices.
Documentation
- Quick start — registry helpers and test trait
- Installation — Flex, manual setup, and install profiles
- Configuration — no app YAML required
- Usage — registry helpers and PHPUnit assertions
- Registry — schema, catalogs, and markup contract
- Components — tier packages and styling
- Upgrade — version migration
- Verification — clean-app smoke and integration profile
Requirements
- PHP 8.2 or higher
- Symfony 7.4 or 8.x