README

English | 🇩🇪 Deutsch

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.

✨ Features

Content Types (Form Fields)

Colour Select - Colour selection with colour display for better visualisation
Number With Default - Number with storable default value
Slider Range - Slider
Star Rating - Selection field for star rating

List Transformers (list view)

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

📋 Requirements

PHP 8.2+
Sulu CMS 3.0+
Symfony 6.4+ / 7.0+

🚀 Installation

Requirement: Sulu CMS 3.0+

Step 1: Install via Composer

composer require manuxi/sulu-admin-extras-bundle

Step 2: Register Bundle

Add to config/bundles.php:

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

Step 3: Admin Assets Setup

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 --save classnames
npm install
npm run build

🧶 Configuration

Create config/packages/sulu_admin_extras.yaml (or copy it from the bundle: vendor/manuxi/sulu-admin-extras-bundle/src/Resources/config/packages/sulu_admin_extras.yaml) and modify it to your needs.

See detailed configuration options in the detailed documentations in docs/ (linked above under features).

👩‍🍳 Contributing

Contributions are welcome! Please feel free to submit issues or pull requests.

📄 License

This bundle is released under the MIT License.

manuxi / sulu-admin-extras-bundle

Maintainers

Details