README

UX Blocks

Registry schema and shared test helpers for the Symfinity UX Blocks component family

Note

Read-only mirror. See CONTRIBUTING.md.

Features

• Registry schema — version 1.1, default prefix blocks, fragment id helpers
• Tier role catalogs — canonical role lists for core, extended, interactive, live, marketing, ecommerce, and lab packages
• PHPUnit assertions — ChameleonMarkupAssertions for data-ui-role / data-ui-fragment DOM checks
• Slim SDK boundary — no Twig components here; tiers 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

use Symfinity\UxBlocks\Registry\CoreRoleCatalog;
use Symfinity\UxBlocks\Registry\RegistrySchema;

$fragment = RegistrySchema::fragmentId('button'); // blocks.button
$roles = CoreRoleCatalog::roles();

composer require symfinity/ux-blocks-core

See Quick start for PHPUnit markup assertions and tier pairing.

Documentation

• Quick start — registry helpers and test trait
• Installation — Flex and manual setup
• Configuration — no app YAML required
• Registry — schema, catalogs, markup contract
• Components — tier packages and styling
• Upgrade — first release notes

Requirements

• PHP 8.2 or higher
• Symfony 7.4 or 8.x

Support

• GitHub Issues
• Security
• Contributing

License

MIT