Skip to content

installation.md

Latest commit

 

History

History
72 lines (47 loc) · 2.56 KB

installation.md

File metadata and controls

72 lines (47 loc) · 2.56 KB
Raw

Installation

Prerequisites

Add the symfinity/recipes Flex endpoint to your project's composer.json (see recipes README).

Composer

composer require symfinity/ux-blocks

This package is typically pulled in automatically when you require a tier package such as symfinity/ux-blocks-core.

Symfony Flex

The recipe applies:

  • Bundle registration for all environments (all)

There is no app config file to copy — the bundle only loads internal services. See Configuration.

Manual installation

When Flex is unavailable:

  1. composer require symfinity/ux-blocks
  2. Register Symfinity\UxBlocks\SymfinityUxBlocksBundle in config/bundles.php for all environments

Verify installation

php bin/console debug:container --tag=container.service_locator | grep -i uxblocks || true
php bin/console about

The bundle has no public console commands. Confirm the package is present in composer show symfinity/ux-blocks.

Install profiles {#install-profiles}

Pick the smallest profile that fits your app.

Profile composer require Use case
Headless atoms symfinity/ux-blocks-core Custom CSS; no UI Kernel theme
Headless + forms symfinity/ux-blocks-core symfinity/ux-blocks-form Atoms plus form controls
Kernel-styled app symfinity/ui-kernel symfinity/ux-blocks-core Symfinity default styled atoms
Kernel-styled app + forms symfinity/ui-kernel symfinity/ux-blocks-core symfinity/ux-blocks-form Typical CRUD apps
Full app UI symfinity/ux-blocks-full Complete official catalog (core + form + extended + interactive + live)
Full app UI + Chameleon symfinity/ui-kernel symfinity/ux-blocks-full Symfinity styled complete catalog 
# Headless atoms
composer require symfinity/ux-blocks-core

# Kernel-styled app
composer require symfinity/ui-kernel symfinity/ux-blocks-core

# Full app UI (complete catalog — one line)
composer require symfinity/ux-blocks-full

# Full app UI + Chameleon styling
composer require symfinity/ui-kernel symfinity/ux-blocks-full
  • data-ui-role is injected by the role attribute bridge (core tier and above).
  • data-ui-fragment is off by default; enable in tier config when you need Turbo/runtime fragment ids.

Next steps