Documentation Home

Theme Module

The theme module adds the ability to have multiple configured themes inside of a Broadleaf instance. A theme is considered a self-contained set of Thymeleaf HTML templates, JS, CSS, and static assets (e.g.: images). Additionally, the theme module allows:

  • Editing theme files (HTML, CSS, JS) directly through the Broadleaf admin. When used in conjunction with the Enterprise module, edits to these files will be done in a sandbox environment and will be able to previewed on the site.
  • Configuring theme variables through the admin. Theme authors are able to define variables in their HTML, CSS, and JS files and expose them to be edited in the admin.

Compatibility

Module Version Compatible Broadleaf Versions
2.1.0-GA 5.1.0-GA
2.3.0-GA 5.2.0-GA

Module Dependencies

Optional Dependencies

Module Installation

For detailed instructions on how to integrate the theme module into your project, please see Module Installation.

Creating Themes

For more information on how to configure variables and create themes, please visit the Theme Variables page.