eekes / sulu-admin-ux-bundle
UX improvements for the Sulu administration interface
Package info
github.com/eekes/sulu-admin-ux-bundle
Language:JavaScript
Type:symfony-bundle
pkg:composer/eekes/sulu-admin-ux-bundle
Requires
- php: ^8.2
- sulu/sulu: ^3.0
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Over the years I have built many dozens of Sulu websites. This bundle collects the improvements to the Sulu administration interface that kept proving useful across those projects: small additions that make a form quicker to scan and quicker to fill in, without changing how Sulu stores or resolves the content.
Features
Forms
| Feature | What it does |
|---|---|
| Tabs in forms | A section named tabs renders its child sections as tabs instead of stacking them underneath each other |
Form fields
| Field type | What it does |
|---|---|
| headline | A heading as one field, with the level as a dropdown inside the title input |
| table | A read-only table on a detail page, built from the rows the form's API returns |
| info_card | A read-only summary of a record: a label left, its value right |
| text_card | A read-only block of text, one line per entry |
List field transformers
| Transformer | What it does |
|---|---|
| link | A URL in a list, shown as a button that opens it |
| money | An amount stored in cents, shown as a formatted amount in a list |
Installation
composer require eekes/sulu-admin-ux-bundle
Symfony Flex registers the bundle. Add the javascript package to assets/admin/package.json:
"sulu-admin-ux-bundle": "file:../../vendor/eekes/sulu-admin-ux-bundle/src/Resources/js"
Import it in assets/admin/app.js:
import 'sulu-admin-ux-bundle';
Finally, rebuild the administration interface.
Compatibility
Built and tested against sulu/sulu 3.0. Every feature uses the components of sulu-admin-bundle as they
are, except the tabs: Sulu's form renderer has no extension point for a third kind of form item, so the
bundle replaces its renderItem method and hands everything that is not a group of tabs back to the
original. That is the one part of this bundle to check first after a Sulu upgrade.