Skip to content
Chuck Lorenz edited this page Jun 5, 2015 · 32 revisions

adapt-contrib-boxMenu

BoxMenu is a menu bundled with the Adapt framework.
When a learner clicks on a hot spot within the image, a popup is displayed that consists of text with an image.

Visit the BoxMenu Wiki for more information about its functionality and for explanations of key properties.

image of two rectangular menu options produced by box menu

##Installation

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

  • If BoxMenu 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

    Alternatively, this component can also be installed by adding the following line of code to the adapt.json file:
    "adapt-contrib-boxMenu": "*"
    Then running the command:
    adapt install
    (This second method will reinstall all plug-ins listed in adapt.json.)

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

Settings overview

The attributes listed below are used in contentObjects.json to configure BoxMenu, and are properly formatted as JSON in example.json. Visit the BoxMenu wiki for more information about how they appear in the authoring tool.

Attributes

_id (string):

_parentId (string):

_type (string):

_classes (string): CSS class name to be applied to BoxMenu’s containing div. The class must be predefined in one of the Less files. Separate multiple classes with a space.

title (string):

displayTitle (string):

body (string):

_graphic (object):

alt (string):

src (string): "course/en/images/origami-menu-one.jpg"

linkText (string): "View"

durationLabel (string): "Duration:"

duration (string): "2 mins"

Limitations

No known limitations.

Browser spec

This menu has been tested to the standard Adapt browser specification.


Version number: 2.0
Framework versions: 2.0
Author / maintainer: Adapt Core Team
Accessibility support: WAI AA
RTL support: yes
Cross-platform coverage: Chrome, Chrome for Android, Firefox (ESR + latest version), IE 11, IE10, IE9, IE8, IE Mobile 11, iPhone (iOS 7+8), Safari iPad (iOS 7+8), Safari 8, Opera

Clone this wiki locally