Skip to content

Latest commit

 

History

History
115 lines (67 loc) · 9.93 KB

README.md

File metadata and controls

115 lines (67 loc) · 9.93 KB

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.

The component uses rangeslider.js (v2.1.1), a library that provides a polyfill for browsers that do not have support for the 'range' input type. rangeslider.js carries the MIT license compatible with Adapt.

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.

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.

_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.

_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.

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

_scaleStep (number): Defines the amount the scale should be incremented by.

_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): When 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.

_showScale (boolean): When set to false, visual indications of the scale—range of numbers and short rules—are not displayed. 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 three types of answers: correct, _incorrect, and _partlyCorrect. Some attributes are optional. If they are not supplied, the default that is noted below will be used.

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.

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

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

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

Accessibility

Slider 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

No known limitations.


Version number: 2.1.0 adapt learning logo Framework versions: 2.0
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 12, IE 11, IE10, IE9, IE8, IE Mobile 11, Safari for iPhone (iOS 8+9), Safari for iPad (iOS 8+9), Safari 8, Opera