Home - adaptlearning/adapt-contrib-slider GitHub Wiki

#Slider

Slider is a presentation component bundled with the Adapt framework.

This component allows learners to position a slider on a scale from 1 to 10. The correct answer can be a single point on the scale or any point on a given range, for example any number between 5-7 could be marked as a correct option or you could be more accurate and require just a single number be chosen.

Visit the page dedicated to Usage and Tips.

##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

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

##Settings

The settings listed below are the properties that may be configured within the authoring tool. Listed first is the name of the property as it is presented in the authoring tool. It is followed in parentheses by the property as it is used in the Slider source code. Finally, an explanation is provided to help the course author better utilize the property.

The relationship between Slider's properties and the way they are presented in the authoring tool’s interface is governed by properties.schema.

Title (title): A reference title for the component. Title is distinct from the Display Title which, if present, appears above the component. If Display Title is rather long, Title provides the opportunity to use a shortened form in tighter spaces, such as in a menu or in the drawer.

Display Title (displayTitle): Optional text that will display as a title above the component. It can be used as a headline. In the authoring tool, Title and Display Title may be linked for easy input. Click the chain icon to toggle linking.

Body (body): Optional text that appears above the component. It can be used in a variety of ways, including as an introduction to the content in the component. HTML is permitted.

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

Classes (_classes): Custom classes predefined in the theme's Less files may be applied to this component. To do this, enter the name of the CSS class. If using more than one class, separate each with a space.

Layout (_layout): This defines the horizontal position of the component in the block that contains it. This property is set when the component is being added to the block. When Add to left or Add to right is selected, another component can occupy the space next to it. If Add is selected, the component spans the width of the containing block.

Attempts (_attempts): This specifies the number of times a learner is allowed to submit an answer.

Should Display Attempts (_shouldDisplayAttempts): Determines whether or not the text set in Final Attempt Text and Attempts Remaining Text will be displayed. These two attributes are part of the core buttons attribute group.

Question Weight (_questionWeight): 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.

Scale Label - Start (labelStart): Text/characters that appear at the start of the slider scale.

Scale Label - End (labelEnd): Text/characters that appear at the end of the slider scale.

Scale Start (_scaleStart): This value is the numeric start of the scale. It is used to calculate the slider's position on the scale.

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

Correct Answer (_correctAnswer): 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.)

Correct Range (_correctRange): Used to set a range of values on the slider scale as the correct answer. The range is determined by Correct Range - Bottom and Correct Range - Top.

Correct Range - Bottom (_bottom): This number is the start value for the correct range.

Correct Range - Top (_top): This number is the end value for the correct range.

Show Numbers on Scale (_showNumber): When set to true, a numeric value appears above the scale when the slider is moved. The value indicates the slider's position on the scale.

Show scale indicators (_showScaleIndicator): When set to true, a marker for the position of the slider along the scale is shown. If Show Numbers on Scale is true, this marker will contain a numeric value. If Show Numbers on Scale is false, a blank marker is shown.

Feedback (_feedback): 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 Partly Correct.

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

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

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

Incorrect Not Final (notFinal): Text that will be displayed when the submitted answer is incorrect while more attempts are permitted.

Partly Correct (_partlyCorrect): Texts that will be displayed when the submitted answer is partially correct. It contains values that are displayed under differing conditions: Final and Not Final.

Partly Correct Final (final): Text that will be displayed when the submitted answer is partly correct and no more attempts are permitted.

Partly Correct Not Final (notFinal): Text that will be displayed when the submitted answer is partly correct while more attempts are permitted.

##Limitations

No known limitations.