triggered RDME

adapt-contrib-triggered

Triggered is an extension bundled with the Adapt framework.
Triggered is attached to a component. It hides the component while displaying a button in its stead. When the learner clicks on the button the component is displayed and the button hidden.

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

##Installation

As one of Adapt's core extensions, Triggered is included with the installation of the Adapt framework and the installation of the Adapt authoring tool.

• If Triggered 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-triggered

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

• If Triggered 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 to configure Triggered. They are appended to a component model in components.json and are properly formatted as JSON in example.json. Visit the Triggered wiki for more information about how they appear in the authoring tool.

Attributes

_triggered (object): The Triggered object that contains values for _isEnabled, _top, _left, showButtonText, and hideButtonText.

_isEnabled (boolean): The extension can be deactivated by setting this attribute to false. This attribute is most useful during development. It should be set to true before publishing.

_top (number): This attribute positions the top edge of the button to this number of pixels below the top edge of the component's containing element. Positive numbers position the button below the top edge; negative numbers position it above.

_left (number): This attribute positions the left edge of the button to this number of pixels from the left edge of the component's containing element. Positive numbers position the button to the right of the left edge; negative numbers position it to the left.

showButtonText (string): Text on the button that shows the component.

hideButtonText (string): Text on the button that hides the component.

Limitations

Browser spec

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

---

Version number:
Framework versions:
Author / maintainer: Adapt Core Team
Accessibility support: WAI AA
RTL support: yes
Cross-platform coverage: