README

⚠️ Deprecation Notice

This project is deprecated and no longer maintained.
Use the recommended alternative:
Enabel UX

Introduction

The bundle aims to provide basic layout and helpers for Symfony applications, including:

• Responsive Bootstrap 5 layout with Enabel styling
• Configurable Twig Components:
  • Alert messages with different types (success, danger, error, warning, info)
  • Theme switcher (light/dark mode)
  • Locale switcher for multilingual applications
  • User menu with customizable actions
• Favicon configuration and management
• Error page templates
• Email templates
• CSS theming based on Enabel's design system

Key Features

• Responsive Layout System: Pre-configured Bootstrap 5 layout with Enabel branding
• Twig Components: Ready-to-use UI components with minimal configuration
• Theme Support: Built-in light/dark mode switching
• Internationalization: Easy locale switching for multilingual applications
• Accessibility: Components designed with accessibility in mind
• User Interface: User menu and authentication integration
• Customization: Configurable application name, description, and supported locales
• Modern Frontend: Uses AssetMapper for efficient asset management

Installation & Usage

Full installation and usage documentation is available here

Using Symfony Flex, don't forget to add the recipes endpoint:

{
  "extra": {
    "symfony": {
      "endpoint": [
        "https://api.github.com/repos/Enabel/recipes/contents/index.json?ref=flex/main",
        "flex://defaults"
      ],
      "allow-contrib": true
    }
  }
}

Requirements & Compatibility

• PHP: 8.0 or higher
• Symfony: 6.0+ and 7.0+ supported
• Twig: 3.4+
• Symfony UX Twig Component: 2.7+

The bundle uses AssetMapper for asset management and requires some packages:

• @enabel/enabel-bootstrap-theme: For Enabel's Bootstrap theme
• @fontsource-variable/maven-pro: For the Maven Pro font

The project follows Semantic Versioning.

You can check the changelog for version history and updates.

Contributing

Feel free to contribute, like sending pull requests to add features/tests or creating issues

Note there are a few helpers to maintain code quality, that you can run using these commands:

composer cs # Code style check
composer stan # Static analysis
composer insight # Code analysis 
composer test # Run tests