README

A bundle for Sulu CMS that adds useful Content Types (Form Fields) and List Transformers (Visualizations) to the Admin UI.

This bundle combines and modernizes functionality from the former SuluContentTypesBundle and SuluTweaksBundle for Sulu 3.0.

English | 🇩🇪 Deutsch

📚 Features & Documentation

Detailed documentation for each feature can be found in the docs/ folder:

Content Types

Colour Select - Colour selection with colour display for better visualisation
Number With Default - Number with storable default value (fixes Sulu limitation)
Slider Range - Slider
Star Rating - Selection field for star rating
DateTime Start / End - Linked date-time pickers with auto end-time, business hours validation and next-slot finder
DateTime With Default - Date-time picker with working default_value support (fixes Sulu limitation)
Business Hours - Weekly schedule with time slots, breaks and copy function
Public Holidays - Holiday manager with Nager.Date API integration
Holiday Dates - Company holidays and closure periods with recurring support

List Transformers

Percent Bar - Percentage bar
Publish State - Status display in separate column (default is hidden)
Ghost Locale - Language status in separate column (hidden by default)
Type Colour - Colour display for colour categorisation
Star Rating - Star rating
Color Dot - Colored circle from hex value for quick visual identification in lists

🚀 Installation

Requirement: Sulu CMS 3.0+

1. Install via Composer

composer require manuxi/sulu-admin-extras-bundle

2. Register Bundle

Add to config/bundles.php:

return [
    Manuxi\SuluAdminExtrasBundle\SuluAdminExtrasBundle::class => ['all' => true],
];

3. Admin Assets Setup (Crucial Step)

To load the JavaScript components in the Sulu Admin, you must adjust your project's asset configuration.

A) Update assets/admin/package.json Open the file assets/admin/package.json in your project root. Add or update the dependency to point to the bundle's resources:

{
  "dependencies": {
    "sulu-admin-extras-bundle": "file:../../vendor/manuxi/sulu-admin-extras-bundle/src/Resources"
  }
}

B) Update assets/admin/app.js Open assets/admin/app.js (or index.js) and import the bundle:

import 'sulu-admin-extras-bundle';

C) Install & Build Run the following commands to compile the admin assets:

cd assets/admin
npm install
npm run build

⚙️ Configuration

Copy the default configuration file:

cp vendor/manuxi/sulu-admin-extras-bundle/src/Resources/config/default.yaml config/packages/sulu_admin_extras.yaml

See docs for detailed configuration options.

manuxi / sulu-admin-extras-bundle

Maintainers

Details