Skip to content

A component that displays an image gallery with accompanying text.

License

Notifications You must be signed in to change notification settings

deltanet/adapt-scenario-audio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

adapt-scenario-audio

Scenario is a presentation component with optional audio.

Scenario displays items (or slides) that present an image and text side-by-side. Left and right navigation controls allow the learner to progress horizontally through the items. Optional text may precede it. Useful for detailing a sequential process. On mobile devices, the scenario text is collapsed above the image.

Installation

Scenario must be nmanually installed.

Settings Overview

The attributes listed below are used in components.json to configure Scenario, and are properly formatted as JSON in example.json.

Attributes

core model attributes: These are inherited by every Adapt component. Read more.

_component (string): This value must be: scenario-audio.

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

_layout (string): This defines the horizontal position of the component in the block. Acceptable values are full, left or right; however, full is typically the only option used as left or right do not allow much room for the component to display.

instruction (string): This optional text appears above the component. It is frequently used to guide the learner’s interaction with the component.

mobileInstruction (string): This is optional instruction text that will be shown when viewed on mobile. It may be used to guide the learner’s interaction with the component.

_setCompletionOn (string): This value determines when the component registers as complete. Acceptable values are "allItems" and "inview". "allItems" requires the learner to navigate to each slide. "inview" requires the Scenario component to enter the view port completely, top and bottom.

_textBelowImage (boolean): If set to 'true', the item text will be displayed below the graphic. Otherwise the text will be dsiplayed below the component body and instruction text.

_items (array): Multiple items may be created. Each item represents one slide and contains values for the scenario (title, body), the image (_graphic), and the slide's header when viewed on a mobile device (_strapLine).

title (string): This value is the title for this scenario element.

body (string): This is the main text for this scenario element.

instruction (string): This optional text appears below the item body. It is frequently used to guide the learner’s interaction with the component.

_graphic (object): The image that appears next to the scenario text. It contains values for src and alt.

src (string): File name (including path) of the image. Path should be relative to the src folder.

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

strapline (string): This text is displayed as a title above the image when Adapt.device.screenSize is small (i.e., when viewed on mobile devices).

Accessibility

Scenario has been assigned a label using the aria-label attribute: ariaRegion. This label is not a visible element. It is utilized by assistive technology such as screen readers. Should the region's text need to be customised, it can be found within the globals object in properties.schema.

Limitations

On mobile devices, the scenario text is collapsed above the image. It is accessed by clicking an icon (+) next the to strapline.


Version number: 4.2.2
Framework versions: 5+
Author / maintainer: Deltanet
Accessibility support: WAI AA
RTL support: yes
Cross-platform coverage: Chrome, Chrome for Android, Firefox (ESR + latest version), Edge 12, IE 11, Safari iOS 9+10, Safari OS X 12