README

The Sulu Snippet Manager Bundle adds configurable snippet-based navigation items to the Sulu Admin interface. This allows you to organize snippets by type and permissions within the native Sulu Admin UI.

🚀 Features

• Custom navigation items for different snippet types
• Optional nested navigation items (e.g. under a main “Configuration” item)
• Independent permission handling per snippet type and snippet navigation item
• Easy custom snippet list view per snippet type
• Hide default snippet area with snippet types, where a certain permission is not given

🛠️ Installation

Install the bundle via composer:

composer require perspeqtive/sulu-snippet-manager-bundle

Enable the bundle

Register it in your config/bundles.php:

return [
// ...
    PERSPEQTIVE\SuluSnippetManagerBundle\SuluSnippetManagerBundle::class => ['all' => true],
];

🛠️ Configuration

Create a configuration file at config/packages/sulu_snippet_manager.yaml. Here you define how and where your snippet navigation items appear in the Sulu Admin UI.

Example configuration:

sulu_snippet_manager:
    navigation:
        configuration:
            navigation_title: "Configuration"
            type: "configuration"
            order: 39
            icon: "su-news"
            children:
                settings:
                    navigation_title: "Settings"
                    type: "settings"
                    order: 0
                    icon: "su-settings"
                    list_view_key: "my-custom-view"
                account:
                    navigation_title: "Account Settings"
                    type: "account"
                    order: 1
                    icon: "su-account"
        services:
            navigation_title: "Services"
            type: "services"
            order: 41
            icon: "su-services"

Configuration keys explained:

Permissions

Each snippet automatically receives its own permission key. These permissions are independent from the global snippet permissions in Sulu.

You can assign user roles to control access (view, add, edit, delete) to each snippet separately.

⚠️ Important: Users without the required permission won’t see the corresponding navigation item in the Sulu Admin UI.

👩‍🍳 Contribution

Please feel free to fork and extend existing or add new features and send a pull request with your changes! To establish a consistent code quality, please provide unit tests for all your changes and adapt the documentation.