Home

Box Menu

Box Menu is a menu bundled with the Adapt framework.

Menu choices are framed within a box element and arranged in a grid. Box Menu allows you to direct the learner to either further menus (sub menus) or to one or more pages of content. The Box Menu default is show a title, an image, some body text, duration, a progress indicator and a link button.

Visit the page dedicated to Usage and Tips.

Installation

As Adapt's core menu, Box Menu is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

• If Box Menu has been uninstalled from the Adapt framework, it may be reinstalled. With the Adapt CLI installed, run the following from the command line:
  adapt install adapt-contrib-boxMenu

• If Box Menu has been uninstalled from the Adapt authoring tool, it may be reinstalled using the Plug-in Manager.

Back to Top

Uninstallation

The Adapt framework does not allow the installation of more than one menu at a time. In order to replace Box Menu it must be uninstalled. With the root of your framework installation as your current working directory, run the following command:
adapt uninstall adapt-contrib-boxMenu

Settings

The settings listed below are the properties that may be configured within the authoring tool. Listed first is the name of the property as it is presented in the authoring tool. It is followed in parentheses by the property as it is used in the Box Menu source code. Finally, an explanation is provided to help the course author better utilize the property.

The relationship between Box Menu's properties and the way they are presented in the authoring tool’s interface is governed by properties.schema.

Classes (_classes): CSS class name to be applied to menu item's page element (src/core/js/views/pageView.js). The class must be predefined in one of the Less files. Separate multiple classes with a space.

Title (title): This text is a reference title for the content object.

Display Title (displayTitle): This text is displayed on the menu item.

Body (body): Optional text that appears on the menu item. Often used to inform the learner about the menu choice. If no Page Body is supplied, this text will also appear as the body text of the page header.

Page Body (pageBody): Optional text that appears as the body text of the page header. If this text is not provided, the Body text will be used (if it is supplied). Reference adapt-contrib-vanilla/templates/page.hbs.

Graphic (_graphic): The image that appears on the menu item. It contains values for Alt and Src.

Alt (alt): This text becomes the image’s alt attribute.

Src (src): File name (including path) of the image. This text is set when you click the icon to select the graphic asset.

Button link text (linkText): This text is displayed on the menu item's link/button.

Duration Label (durationLabel): Optional text which precedes Duration (e.g., "Duration:").

Duration (duration): Optional text which follows durationLabel (e.g., "2 mins").

Back to Top

Limitations

No known limitations.