Steps to enable this module in your custom Broadleaf Commerce project. These steps are based on projects that are
similar to the Broadleaf Commerce demo application which contains a core, site, and admin project which are all contained in a "parent project".

Note: that the 3.2 version of the demo application already has this menu module included.

Steps

Step 1. Add the following to the dependency management section of your parent pom.xml:
The parent pom is the one located in the root directory of the Broadleaf Commerce project.

    <dependency>
        <groupId>org.broadleafcommerce</groupId>
        <artifactId>broadleaf-menu</artifactId>
        <version>1.0.0-GA</version>
        <type>jar</type>
        <scope>compile</scope>
    </dependency>

Step 2. Pull this dependency into your core/pom.xml:

    <dependency>
        <groupId>org.broadleafcommerce</groupId>
        <artifactId>broadleaf-menu</artifactId>
    </dependency>

Data Changes

Schema Changes

If you are allowing hibernate to create and modify your tables, this will be done automatically when you restart with the new configuration settings.

Otherwise, you will need to generate the SQL to customize your Broadleaf implementation. See the Broadleaf Schema Upgrade Documentation for details.

Admin Security Changes

To create the Menu management section in the Broadleaf admin, you will need to load new permissions. The recommended changes are located in the following files:

/config/bc/sql/load_menu_admin_security.sql

Note: In development, you can automatically load this SQL files by adding it to the blPU.hibernate.hbm2ddl.import_files property in the development-shared.properties file.

View Changes

If you are using the Heat Clinic demo as a starting point. You can utilize the new Thymeleaf MenuProcessor to draw your navigation.
Add something like the following to your nav.html file:

    <blc:menu resultVar="menuItems" menuName="Header Nav" />
    <ul th:if="${menuItems}">
        <li th:each="menuItem : ${menuItems}">

            <a th:href="@{${menuItem.url}}" th:class="${menuItemStat.first}? 'home'">
                <span th:text="${menuItem.label}"></span>
            </a>
            <ul th:if="${menuItem.submenu != null}" class="sub-menu">
                <li th:each="submenuItem : ${menuItem.submenu}">
                    <a th:href="@{${submenuItem.url}}" th:text="${submenuItem.label}"></a>
                </li>
            </ul>

        </li>
    </ul>