Dashboards

3.x version

Maintained

edit this page

Dashboards¶

WARNING: You are browsing the documentation for EasyAdmin 3.x, which has just been released. Switch to EasyAdmin 2.x docs if your application has not been upgraded to EasyAdmin 3 yet.

Dashboards are the entry point of backends and they link to one or more resources. Dashboards also display a main menu to navigate the resources and the information of the logged in user.

Imagine that you have a simple application with three Doctrine entities: users, blog posts and categories. Your own employees can create and edit any of them but external collaborators can only create blog posts.

You can implement this in EasyAdmin as follows:

Create three CRUD controllers (e.g. UserCrudController, BlogPostCrudController and CategoryCrudController);
Create a dashboard for your employees (e.g. DashboardController) and link to the three resources;
Create a dashboard for your external collaborators (e.g. ExternalDashboardController) and link only to the BlogPostCrudController resource.

Technically, dashboards are regular Symfony controllers so you can do anything you usually do in a controller, such as injecting services and using shortcuts like $this->render() or $this->isGranted().

Dashboard controller classes must implement the EasyCorp\Bundle\EasyAdminBundle\Contracts\Controller\DashboardControllerInterface, which ensures that certain methods are defined in the dashboard. Instead of implementing the interface, you can also extend from the AbstractDashboardController class. Run the following command to quickly generate a dashboard controller:

1	$ php bin/console make:admin:dashboard

Dashboard Route¶

Each dashboard uses a single Symfony route to serve all its URLs. The needed information is passed using query string parameters. If you generated the dashboard with the make:admin:dashboard command, the route is defined using Symfony route annotations:

namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
use Symfony\Component\Routing\Annotation\Route;

class DashboardController extends AbstractDashboardController
{
    /**
     * @Route("/admin")
     */
    public function index(): Response
    {
        return parent::index();
    }

    // ...
}

The /admin URL is only a default value, so you can change it. If you do that, don’t forget to also update this value in your Symfony security config to restrict access to the entire backend.

There’s no need to define a explicit name for this route. Symfony autogenerates a route name and EasyAdmin gets that value at runtime to generate all URLs. However, if you generate URLs pointing to the dashboard, you may want to define an explicit name for the route to simplify your code:

/**
 * @Route("/admin", name="some_route_name")
 */
public function index(): Response
{
    return parent::index();
}

If you don’t use annotations, you must configure the dashboard route using YAML, XML or PHP config in a separate file. For example, when using YAML:

# config/routes.yaml
dashboard:
    path: /admin
    controller: App\Controller\Admin\DashboardController::index

# ...

In practice you won’t have to deal with this route or the query string parameters in your application because EasyAdmin provides a service to generate CRUD URLs.

Note

Using a single route for all URLs means that generated URLs are a bit ugly. In exchange, all the other features are much simpler, from generating URLs to protecting the entire backend.

Dashboard Configuration¶

The basic dashboard configuration is defined in the configureDashboard() method (the main menu and the user menu are configured in their own methods, as explained later):

namespace App\Controller\Admin;

use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;

class DashboardController extends AbstractDashboardController
{
    // ...

    public function configureDashboard(): Dashboard
    {
        return Dashboard::new()
            // the name visible to end users
            ->setTitle('ACME Corp.')
            // you can include HTML contents too (e.g. to link to an image)
            ->setTitle('<img src="..."> ACME <span class="text-small">Corp.</span>')

            // the path defined in this method is passed to the Twig asset() function
            ->setFaviconPath('favicon.svg')

            // the domain used by default is 'messages'
            ->setTranslationDomain('my-custom-domain')

            // there's no need to define the "text direction" explicitly because
            // its default value is inferred dynamically from the user locale
            ->setTextDirection('ltr')

            // set this option if you prefer the page content to span the entire
            // browser width, instead of the default design which sets a max width
            ->renderContentMaximized()

            // set this option if you prefer the sidebar (which contains the main menu)
            // to be displayed as a narrow column instead of the default expanded design
            ->renderSidebarMinimized()
        ;
    }
}

Main Menu¶

The main menu links to different CRUD controllers from the dashboard. It’s the only way to associate dashboards and resources. For security reasons, a backend can only access to the resources associated to the dashboard via the main menu.

The main menu is a collection of objects implementing EasyCorp\Bundle\EasyAdminBundle\Contracts\Menu\MenuInterface that configure the look and behavior of each menu item:

use App\Entity\BlogPost;
use App\Entity\Category;
use App\Entity\Comment;
use App\Entity\User;
use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;

class DashboardController extends AbstractDashboardController
{
    // ...

    public function configureMenuItems(): iterable
    {
        return [
            MenuItem::linkToDashboard('Dashboard', 'fa fa-home'),

            MenuItem::section('Blog'),
            MenuItem::linkToCrud('Categories', 'fa fa-tags', Category::class),
            MenuItem::linkToCrud('Blog Posts', 'fa fa-file-text', BlogPost::class),

            MenuItem::section('Users'),
            MenuItem::linkToCrud('Comments', 'fa fa-comment', Comment::class),
            MenuItem::linkToCrud('Users', 'fa fa-user', User::class),
        ];
    }
}

The first argument of MenuItem::new() is the label displayed by the item and the second argument is the full CSS class of the FontAwesome icon to display.

Menu Item Configuration Options¶

All menu items define the following methods to configure some options:

setCssClass(string $cssClass), sets the CSS class or classes applied to the <li> parent element of the menu item;
setLinkRel(string $rel), sets the rel HTML attribute of the menu item link (check out the allowed values for the “rel” attribute);
setLinkTarget(string $target), sets the target HTML attribute of the menu item link (_self by default);
setPermission(string $permission), sets the Symfony security permission that the user must have to see this menu item. Read the menu security reference for more details.

The rest of options depend on each menu item type, as explained in the next sections.

Menu Item Types¶

CRUD Menu Item¶

This is the most common menu item type and it links to some action of some CRUD controller. Instead of passing the FQCN (fully-qualified class name) of the CRUD controller, you must pass the FQCN of the Doctrine entity associated to the CRUD controller:

use App\Entity\Category;
use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;

public function configureMenuItems(): iterable
{
    return [
        // ...

        // links to the 'index' action of the Category CRUD controller
        MenuItem::linkToCrud('Categories', 'fa fa-tags', Category::class),

        // links to a different CRUD action
        MenuItem::linkToCrud('Add Category', 'fa fa-tags', Category::class)
            ->setAction('new'),

        MenuItem::linkToCrud('Show Main Category', 'fa fa-tags', Category::class)
            ->setAction('detail')
            ->setEntityId(1),

        // if the same Doctrine entity is associated to more than one CRUD controller,
        // use the 'setController()' method to specify which controller to use
        MenuItem::linkToCrud('Categories', 'fa fa-tags', Category::class)
            ->setController(LegacyCategoryCrudController::class),

        // uses custom sorting options for the listing
        MenuItem::linkToCrud('Categories', 'fa fa-tags', Category::class)
            ->setQueryParameter('sortField', 'createdAt'),
            ->setQueryParameter('sortDirection', 'DESC'),
    ];
}

Route Menu Item¶

It links to any of the Symfony application routes:

use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;

public function configureMenuItems(): iterable
{
    return [
        MenuItem::linkToRoute('The Label', 'fa ...', 'route_name'),
        MenuItem::linkToRoute('The Label', 'fa ...', 'route_name', [ ... route parameters ... ]),
        // ...
    ];
}

When using route menu items, EasyAdmin adds the following route parameters automatically (in addition to the optional route parameters defined by you):

menuIndex and submenuIndex: they are needed to keep the selected menu item when rendering the page of your action (in case you display the main menu);
eaContext: a random-looking alphanumeric string that identifies the Dashboard controller related to this action (this string is generated using the application kernel secret, so it cannot be guessed by malicious users). This is needed to load the dashboard configuration used to render the backend layout (in case your action uses it). If you don’t add this parameter and try to use EasyAdmin templates, you’ll see errors such as “Variable “ea” does not exist.” (which is related to the admin context).

Note

The path of your route probably doesn’t include these parameters added by EasyAdmin, but that’s fine (you’ll see them as query string parameters).

URL Menu Item¶

It links to a relative or absolute URL:

use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;

public function configureMenuItems(): iterable
{
    return [
        MenuItem::linkToUrl('Visit public website', null, '/'),
        MenuItem::linkToUrl('Search in Google', 'fab fa-google', 'https://google.com'),
        // ...
    ];
}

To avoid leaking internal backend information to external websites, if the menu item links to an external URL and doesn’t define its rel option, the rel="noreferrer" attribute is added automatically.

Logout Menu Item¶

It links to the URL that the user must visit to log out from the application. If you know the logout route name, you can achieve the same with the “route menu item”, but this one is more convenient because it finds the logout URL for the current security firewall automatically:

use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;

public function configureMenuItems(): iterable
{
    return [
        // ...
        MenuItem::linkToLogout('Logout', 'fa fa-exit'),
    ];
}

Note

The logout menu item will not work under certain authentication schemes like HTTP Basic because they do not have a default logout path configured due to the nature of how those authentication schemes work.

If you encounter an error like “Unable to find the current firewall LogoutListener, please provide the provider key manually.”, you’ll need to remove the logout menu item or add a logout provider to your authentication scheme.

Submenus¶

The main menu can display up to two level nested menus. Submenus are defined using the subMenu() item type:

use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;

public function configureMenuItems(): iterable
{
    return [
        MenuItem::subMenu('Blog', 'fa fa-article')->setSubItems([
            MenuItem::linkToCrud('Categories', 'fa fa-tags', Category::class),
            MenuItem::linkToCrud('Posts', 'fa fa-file-text', BlogPost::class),
            MenuItem::linkToCrud('Comments', 'fa fa-comment', Comment::class),
        ]),
        // ...
    ];
}

Note

In a submenu, the parent menu item cannot link to any resource, route or URL; it can only expand/collapse the submenu items.

Complex Main Menus¶

The return type of the configureMenuItems() is iterable, so you don’t have to always return an array. For example, if your main menu requires complex logic to decide which items to display for each user, it’s more convenient to use a generator to return the menu items:

public function configureMenuItems(): iterable
{
    yield MenuItem::linkToDashboard('Dashboard', 'fa fa-home');

    if ('... some complex expression ...') {
        yield MenuItem::section('Blog');
        yield MenuItem::linkToCrud('Categories', 'fa fa-tags', Category::class);
        yield MenuItem::linkToCrud('Blog Posts', 'fa fa-file-text', BlogPost::class);
    }

    // ...
}

User Menu¶

When accessing a protected backend, EasyAdmin displays the details of the user who is logged in the application and a menu with some options like “logout” (if Symfony’s logout feature is enabled).

The user name is the result of calling to the __toString() method on the current user object. The user avatar is a generic avatar icon. Use the configureUserMenu() method to configure the features and items of this menu:

use EasyCorp\Bundle\EasyAdminBundle\Config\MenuItem;
use EasyCorp\Bundle\EasyAdminBundle\Config\UserMenu;
use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
use Symfony\Component\Security\Core\User\UserInterface;

class DashboardController extends AbstractDashboardController
{
    // ...

    public function configureUserMenu(UserInterface $user): UserMenu
    {
        // Usually it's better to call the parent method because that gives you a
        // user menu with some menu items already created ("sign out", "exit impersonation", etc.)
        // if you prefer to create the user menu from scratch, use: return UserMenu::new()->...
        return parent::configureUserMenu($user)
            // use the given $user object to get the user name
            ->setName($user->getFullName())
            // use this method if you don't want to display the name of the user
            ->displayUserName(false)

            // you can return an URL with the avatar image
            ->setAvatarUrl('https://...')
            ->setAvatarUrl($user->getProfileImageUrl())
            // use this method if you don't want to display the user image
            ->displayUserAvatar(false)
            // you can also pass an email address to use gravatar's service
            ->setGravatarEmail($user->getMainEmailAddress())

            // you can use any type of menu item, except submenus
            ->addMenuItems([
                MenuItem::linkToRoute('My Profile', 'fa fa-id-card', '...', ['...' => '...']),
                MenuItem::linkToRoute('Settings', 'fa fa-user-cog', '...', ['...' => '...']),
                MenuItem::section(),
                MenuItem::linkToLogout('Logout', 'fa fa-sign-out'),
            ]);
    }
}

Admin Context¶

EasyAdmin initializes a variable of type EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext automatically on each backend request. This object implements the context object design pattern and stores all the information commonly needed in different parts of the backend.

This context object is automatically injected in every template as a variable called ea (the initials of “EasyAdmin”):

<h1>{{ ea.dashboardTitle }}</h1>

{% for menuItem in ea.mainMenu.items %}
    {# ... #}
{% endfor %}

The AdminContext variable is created dynamically on each request, so you can’t inject it directly in your services. Instead, use the AdminContextProvider service to get the context variable:

use EasyCorp\Bundle\EasyAdminBundle\Provider\AdminContextProvider;

final class SomeService
{
    private $adminContextProvider;

    public function __construct(AdminContextProvider $adminContextProvider)
    {
        $this->adminContextProvider = $adminContextProvider;
    }

    public function someMethod()
    {
        $context = $this->adminContextProvider->getContext();
    }

    // ...
}

In controllers, use the AdminContext type-hint in any argument where you want to inject the context object:

use EasyCorp\Bundle\EasyAdminBundle\Context\AdminContext;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class SomeController extends AbstractController
{
    public function someMethod(AdminContext $context)
    {
        // ...
    }
}

Translation¶

The backend interface is fully translated using the Symfony translation features. EasyAdmin own messages and contents use the EasyAdminBundle translation domain (thanks to our community for kindly providing translations for tens of languages).

The rest of the contents (e.g. the label of the menu items, entity and field names, etc.) use the messages translation domain by default. You can change this value with the translationDomain() method:

class DashboardController extends AbstractDashboardController
{
    // ...

    public function configureDashboard(): Dashboard
    {
        return Dashboard::new()
            // ...

            // the argument is the name of any valid Symfony translation domain
            ->setTranslationDomain('admin');
    }
}

The backend uses the same language configured in the Symfony application. When the locale is Arabic (ar), Persian (fa) or Hebrew (he), the HTML text direction is set to rtl (right-to-left) automatically. Otherwise, the text is displayed as ltr (left-to-right), but you can configure this value explicitly:

class DashboardController extends AbstractDashboardController
{
    // ...

    public function configureDashboard(): Dashboard
    {
        return Dashboard::new()
            // ...

            // most of the times there's no need to configure this explicitly
            // (default: 'rtl' or 'ltr' depending on the language)
            ->setTextDirection('rtl');
    }
}

Tip

If you want to make the backend use a different language than the public website, you’ll need to work with the user locale to set the request locale before the translation service retrieves it.

Note

The contents stored in the database (e.g. the content of a blog post or the name of a product) are not translated. EasyAdmin does not support the translation of the entity property contents into different languages.

Page Templates¶

EasyAdmin provides several page templates which are useful when adding custom logic in your dashboards.

Login Form Template¶

Twig Template Path: @EasyAdmin/page/login.html.twig

It displays a simple username + password login form that matches the style of the rest of the backend. The template defines lots of config options, but most applications can rely on its default values:

namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;
use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;

class SecurityController extends AbstractController
{
    /**
     * @Route("/login", name="login")
     */
    public function login(AuthenticationUtils $authenticationUtils): Response
    {
        $error = $authenticationUtils->getLastAuthenticationError();
        $lastUsername = $authenticationUtils->getLastUsername();

        return $this->render('@EasyAdmin/page/login.html.twig', [
            // parameters usually defined in Symfony login forms
            'error' => $error,
            'last_username' => $lastUsername,

            // OPTIONAL parameters to customize the login form:

            // the translation_domain to use (define this option only if you are
            // rendering the login template in a regular Symfony controller; when
            // rendering it from an EasyAdmin Dashboard this is automatically set to
            // the same domain as the rest of the Dashboard)
            'translation_domain' => 'admin',

            // the title visible above the login form (define this option only if you are
            // rendering the login template in a regular Symfony controller; when rendering
            // it from an EasyAdmin Dashboard this is automatically set as the Dashboard title)
            'page_title' => 'ACME login',

            // the string used to generate the CSRF token. If you don't define
            // this parameter, the login form won't include a CSRF token
            'csrf_token_intention' => 'authenticate',

            // the URL users are redirected to after the login (default: '/admin')
            'target_path' => $this->generateUrl('admin_dashboard'),

            // the label displayed for the username form field (the |trans filter is applied to it)
            'username_label' => 'Your username',

            // the label displayed for the password form field (the |trans filter is applied to it)
            'password_label' => 'Your password',

            // the label displayed for the Sign In form button (the |trans filter is applied to it)
            'sign_in_label' => 'Log in',

            // the 'name' HTML attribute of the <input> used for the username field (default: '_username')
            'username_parameter' => 'my_custom_username_field',

            // the 'name' HTML attribute of the <input> used for the password field (default: '_password')
            'password_parameter' => 'my_custom_password_field',
        ]);
    }
}

Content Page Template¶

Twig Template Path: @EasyAdmin/page/content.html.twig

It displays a simple page similar to the index/detail/form pages, with the main header, the sidebar menu and the central content section. The only difference is that the content section is completely empty, so it’s useful to display your own text contents, custom forms, etc.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

Dashboards

Dashboards¶

Dashboard Route¶

Dashboard Configuration¶

Main Menu¶

Menu Item Configuration Options¶

Menu Item Types¶

CRUD Menu Item¶

Dashboard Menu Item¶

Route Menu Item¶

URL Menu Item¶

Section Menu Item¶

Logout Menu Item¶

Exit Impersonation Menu Item¶

Submenus¶

Complex Main Menus¶

User Menu¶

Admin Context¶

Translation¶

Page Templates¶

Content Page Template¶