Back-Office Themes

A theme is a set of CSS and/or SCSS files that customize the look and feel of OroPlatform. The theme has the following properties:

Property Required Description
name yes A unique name
label no A string that is displayed in the theme management UI.
styles yes The list of CSS and SCSS files that define the theme.
icon no The theme’s favicon.
logo no A logo that is shown in the theme management UI.
screenshot no A screenshot of the theme to be shown in the management UI.

You can create themes in two different ways:

Alternatively, you can customize an existing theme instead of creating a new one from scratch.

Application-specific Themes

Customizing the layout of your Platform application is as easy as defining your custom theme in your application’s configuration using the oro_theme option:

# config/config.yml
                - mytheme/css/main.css
                - mytheme/css/ie.css
            label: My Theme
            icon: mytheme/images/favicon.ico
            logo: mytheme/images/logo.png
            screenshot: /mytheme/images/screenshot.png
    active_theme: mytheme

First, you create a theme named mytheme with the My Theme label that uses two CSS files, main.css and ie.css. Secondly, select the theme to be used by setting its name as the value of the active_theme option.

Reusable Themes

In addition to customizing your own application, you can also provide a theme that can be reused in different applications. To achieve this, specify the theme’s options in the settings.yml file that is located in the Resources/public/themes/<theme-name> directory of your bundle:

# src/Acme/DemoBundle/Resources/public/themes/acme-theme/settings.yml
    - bundles/acmebundle/themes/acme-theme/css/main.css
    - bundles/acmebundle/themes/acme-theme/css/ie.css
label: Acme Demo Theme
icon: bundles/acmebundle/themes/acme-theme/images/favicon.ico
logo: bundles/acmebundle/themes/acme-theme/images/logo.png
screenshot: bundles/acmebundle/themes/acme-theme/images/screenshot.png

To use the theme in any application, enable it in the application configuration:

# config/config.yml
    active_theme: acme-theme


You can use the oro:theme:list command to get a list of all available themes. Its output looks like this:

List of available themes:
acme-theme (active)
 - label: Acme Demo Theme
 - logo: bundles/acmebundle/themes/acme-theme/images/logo.png
 - icon: bundles/acmebundle/themes/acme-theme/images/favicon.ico
 - screenshot: bundles/acmebundle/themes/acme-theme/images/screenshot.png
 - styles:
     - bundles/acmebundle/themes/acme-theme/css/main.css
     - bundles/acmebundle/themes/acme-theme/css/ie.css
 - label: Demo Theme
 - logo: bundles/oroui/themes/demo/images/favicon.ico
 - styles:
     - bundles/oroui/themes/demo/css/scss/main.scss
     - bundles/oroui/themes/demo/css/style.css
 - label: My Theme
 - logo: mytheme/images/logo.png
 - icon: mytheme/images/favicon.ico
 - screenshot: mytheme/images/screenshot.png
 - styles:
     - mytheme/css/main.css
     - mytheme/css/ie.css
 - label: Oro Theme
 - icon: bundles/oroui/themes/oro/images/favicon.ico
 - styles: bundles/oroui/themes/oro/css/style.css

Finally, clear the cache and dump all assets:

$ php bin/console cache:clear
$ php bin/console assets:install --symlink
$ php bin/console oro:assets:build

Override a Theme

The configuration files of all available themes are merged when the service container is being compiled. Since the merge process does override values if they are defined in more than one file, you can make use of it when you need to customize an existing theme.

For example, imagine that you want to use the Oro theme from the OroUIBundle, but you want to use a custom label and favicon for it. The definition of the Oro theme as defined in the bundle looks like this:

label: Oro Theme
icon: bundles/oroui/themes/oro/images/favicon.ico
    - bundles/oroui/themes/oro/css/style.css

So, place the settings.yml file in the Resources/public/themes/oro directory of your bundle and define the values you want to change:

# src/Acme/DemoBundle/Resources/public/oro/
label: Custom Oro Theme
icon: images/custom_favicon.ico


If you override themes from third-party bundles, you have to make sure that your bundle is registered after the bundle it is overriding the themes from:

// src/AppKernel.php
// ...

class AppKernel extends OroKernel
    public function registerBundles()
        $bundles = [
            // ...
            new ThirdParty\Bundle\ThirdPartyBundle(),
            // ...
            new Acme\DemoBundle\AcmeDemoBundle(),
            // ...

        // ...

    // ...