Skip to content

An extension providing an accessible error for invalid question submissions reiterating the question instructions

License

Notifications You must be signed in to change notification settings

adaptlearning/adapt-contrib-instructionError

Repository files navigation

adapt-contrib-instructionError

Instruction Error is an extension which can be installed in the Adapt framework. It provides core question components with the ability to display an error reiterating the question instructions on an invalid submission. The error is configured globally but may take values from the question component.

Installation

Instruction Error can be installed using the Adapt CLI, run the following from the command line: adapt install adapt-contrib-instructionError

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

  • If Instruction Error needs to be installed in the Adapt authoring tool, it may be installed by uploading the zip.

Settings

_instructionError (object): The Instruction Error attributes group contains values for _isEnabled, title and body.

_isEnabled (boolean): Turns on and off the Instruction Error extension. Can only be set in course.json.

title (boolean): Set the notify title for the instruction error. Can only be set in course.json.

body (boolean): Set the notify body for the instruction error, defaults to the question instruction text. Can only be set in course.json.

Limitations

No known limitations.


Framework versions: 5.19.1+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, Safari for macOS/iOS/iPadOS, Opera

About

An extension providing an accessible error for invalid question submissions reiterating the question instructions

Resources

License

Stars

Watchers

Forks

Packages

No packages published