/adapt-contrib-slider

A question component that allows the learner to position a slider on scale

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

adapt-contrib-slider

Slider in action Slider is a question component bundled with the Adapt framework.

To respond to the question, the learner positions a slider along a scale. Upon submission, feedback is provided via the Tutor extension, if installed. Feedback can be provided for correct, incorrect and partially correct answers. The number of attempts allowed may be configured.

Visit the Slider wiki for more information about its functionality and for explanations of key properties.

Installation

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

  • If Slider 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-slider

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

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

Back to Top

Settings Overview

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

Attributes

In addition to the attributes specifically listed below, question components can implement the following sets of attributes:

  • core model attributes: These are inherited by every Adapt component. They have no default values. Like the attributes below, their values are assigned in components.json.
  • core buttons: Default values are found in course.json, but may be overridden by Slider's model in components.json.

_component (string): This value must be: slider.

_classes (string): CSS class name to be applied to Slider’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.

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

ariaQuestion (string): This will be read out by screen readers instead of reading the title, body & instruction fields when focusing on the group or radiogroup.

ariaScaleName (string): This will be read out by screen readers when focusing on the scale input (slider handle). An appropriate name should give context to which the scale is a measurement of.

_attempts (integer): This specifies the number of times a learner is allowed to submit an answer. The default is 1.

_shouldDisplayAttempts (boolean): Determines whether or not the text set in remainingAttemptText and remainingAttemptsText will be displayed. These two attributes are part of the core buttons attribute group. The default is false.

_questionWeight (number): A number which reflects the significance of the question in relation to the other questions in the course. This number is used in calculations of the final score reported to the LMS.

_canShowModelAnswer (boolean): Setting this to false prevents the _showCorrectAnswer button from being displayed. The default is true.

_canShowFeedback (boolean): Setting this to false disables feedback, so it is not shown to the user. The default is true.

_canShowMarking (boolean): Setting this to false prevents ticks and crosses being displayed on question completion. The default is true.

_recordInteraction (boolean) Determines whether or not the learner's answers will be recorded to the LMS via cmi.interactions. Default is true. For further information, see the entry for _shouldRecordInteractions in the README for adapt-contrib-spoor.

labelStart (string): Text/characters that appear at the start of the slider scale.

labelEnd (string): Text/characters that appear at the end of the slider scale.

_scaleStart (number): This value is the numeric start of the scale. It is used to calculate the slider's position on the scale. The default is 1.

_scaleEnd (number): This value is the numeric end of the scale. It is used to calculate the slider's position on the scale. The default is 10.

_scaleStep (number): Defines the amount the scale should be incremented by. The default is 1.

scaleStepPrefix (string): Prefix to add to each slider step. For example, a "$" can be used as a prefix to indicate currency in dollars (ex. $100).

scaleStepSuffix (string): Suffix to add to each slider step. For example, a "V" can be used as a suffix to indicate voltage (ex. 4V).

_correctAnswer (string): Used to set a single value on the slider scale as the correct answer. (Since the attribute expects a string, numeric values must appear in JSON within quotes.)

_correctRange (object): Used to set a range of values on the slider scale as the correct answer. The range is determined by _bottom and _top.

_bottom (number): This number is the start value for the correct range.

_top (number): This number is the end value for the correct range.

_showNumber (boolean): When set to true, a numeric value appears on the marker described in _showScaleIndicator. The value indicates the slider's position on the scale. The default is true. Note that _showScaleIndicator must be set to true in order for this to work.

_showScaleIndicator (boolean): Set to true, a marker for the position of the slider along the scale is shown. If _showNumber is true this marker will contain a numeric value. If _showNumber is false a blank marker is shown. The default is true.

_showScale (boolean): When set to false, visual indications of the scale—range of numbers and short rules—are not displayed. The default is true.

_showScaleNumbers (boolean): When set to false, numbers are not shown over the scale items. Useful if you have a scale with very many steps where displaying that many numbers would make it look crowded or even unreadable. The default is true.

_feedback (object): If the Tutor extension is enabled, these various texts will be displayed depending on the submitted answer. _feedback contains values for two types of answers: correct and _incorrect. Some attributes are optional. If they are not supplied, the default that is noted below will be used.

title (string): Title text for the feedback that will be displayed when the question is submitted.

altTitle (string): This will be read out by screen readers as an alternative title if no visual title is included.

correct (string): Text that will be displayed when the submitted answer is correct.

_incorrect (object): Texts that will be displayed when the submitted answer is incorrect. It contains values that are displayed under differing conditions: final and notFinal.

final (string): Text that will be displayed when the submitted answer is incorrect and no more attempts are permitted.

notFinal (string): Text that will be displayed when the submitted answer is incorrect while more attempts are permitted. This is optional—if you do not supply it, the _incorrect.final feedback will be shown instead.

Accessibility

Slider has been assigned a descriptive label using the aria-label attribute: ariaRegion.

When Slider is used with Adapt Framework v5.12.0 (or better), it supports announcing the correct/learner answer to screen readers (via an an ARIA Live Region) when the Correct Answer button is toggled by the learner. The following attributes are used to provide this functionality: ariaCorrectAnswer, ariaCorrectAnswerRange, ariaUserAnswer.

These ARIA labels are not visible elements; they are used by assistive technology (such as screen readers). Should any of these labels need to be customised or translated, they can be found within the _globals._components._slider object in course.json (or Project settings > Globals in the Adapt Authoring Tool).

Back to Top

Limitations

Does not currently support a descending step value.


adapt learning logo Author / maintainer: Adapt Core Team with contributors
Accessibility support: WAI AA
RTL support: Yes
Cross-platform coverage: Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, IE11, Safari 14 for macOS/iOS/iPadOS, Opera