README

Quick links to the control panel, edit current page, cache pages, other gubbins.

How to Install

You can search for this addon in the Tools > Addons section of the Statamic control panel and click install, or run the following command from your project root:

composer require alt-design/alt-admin-bar

Basic Use

Just slap this in your layout, as Todd Howard says, it should ✨Just Work™ ✨

{{ alt_admin_bar }}

Extending The Bar

We got a lil' event listener when the menu is created, this allows you to add to the menu as you fancy - usage is below:

use AltDesign\AltAdminBar\DTO\MenuItemDTO;

Illuminate\Support\Facades\Event::listen('alt_admin_menu_items', function ($menuItems) {
    
    // Standard link w/ url
    $menuItems[] = MenuItemDTO::make([
        'title' => 'Simple Title',
        'href' => '/simple-link',
    ]);
    
    // Item with Children
    $menuItems[] = MenuItemDTO::make([
        'title' => 'Simple Title With Children',
        'href' => '/simple-title-with-children',
        'children' => [
            MenuItemDTO::make([
                'title' => 'Simple Child',
                'href' => '/simple-child',
            ]),
            MenuItemDTO::make([
                'title' => 'Simple Child ',
                'href' => '/simple-child-2',
            ])
        ]
    ]);
    
    // Control Panel Route (Using Runway as an example)
    $menuItems[] = MenuItemDTO::make([
        'title' => 'Edit Specific Page In Control Panel',
        'href' => 'runway.edit', // Route Name
        'cp_route' => true, // Tells the addon to use the cp_route() helper
        'route_args' => ['resource' => 'example', 'model' => $id]
    ]);
    
    return $menuItems;
    
});

Currently working on a tag to help include this in templates.

Revisions

The Admin Bar supports Statamic's revision system and allows you to step through the revisions made to a page.

Once Revisions are enabled on your site, you'll see a "Revisions" item appear on the right of the menu bar.

This contains a scrolling menu with all the revisions on the current page appeared in descending date order. You can simply select a revision and the page will reload with the content from that revision.

The "Revisions" menu item text will become highlighted to show that a revision is active.

The Revisions system can even display the current working copy for changes that have been save but not published yet, this allows you to preview your changes quickly on the main page.

Please note, this system have been tested with Statamic's base file based entries. Functionality with other entry repos are not tested or supported at the mo

Questions etc

Drop us a big shout-out if you have any questions, comments, or concerns. We're always looking to improve our addons, so if you have any feature requests, we'd love to hear them.

Starter Kits

Alt Starter Kit

Addons

Postcardware

Send us a postcard from your hometown if you like this addon. We love getting mail from other cool peeps!

Alt Design
St Helens House Derby
DE1 3EE UK

alt-design / alt-admin-bar

Maintainers

Details