{"id":21065618,"url":"https://github.com/adaptlearning/adapt-contrib-instructionerror","last_synced_at":"2025-06-15T20:35:47.295Z","repository":{"id":42471225,"uuid":"275865120","full_name":"adaptlearning/adapt-contrib-instructionError","owner":"adaptlearning","description":"An extension providing an accessible error for invalid question submissions reiterating the question instructions","archived":false,"fork":false,"pushed_at":"2024-10-17T14:52:42.000Z","size":81,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-19T12:28:16.483Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adaptlearning.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-29T16:09:27.000Z","updated_at":"2021-11-29T13:55:49.000Z","dependencies_parsed_at":"2024-10-18T06:55:49.443Z","dependency_job_id":null,"html_url":"https://github.com/adaptlearning/adapt-contrib-instructionError","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-instructionError","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-instructionError/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-instructionError/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adaptlearning%2Fadapt-contrib-instructionError/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adaptlearning","download_url":"https://codeload.github.com/adaptlearning/adapt-contrib-instructionError/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243509801,"owners_count":20302268,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T17:55:49.240Z","updated_at":"2025-03-14T01:47:00.702Z","avatar_url":"https://github.com/adaptlearning.png","language":"JavaScript","readme":"# adapt-contrib-instructionError\n\n**Instruction Error** is an *extension* which can be installed in the [Adapt framework](https://github.com/adaptlearning/adapt_framework).\nIt provides core [*question components*](https://github.com/adaptlearning/adapt_framework/wiki/Core-Plug-ins-in-the-Adapt-Learning-Framework#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.\n\n## Installation\n\n**Instruction Error** can be installed using the [Adapt CLI](https://github.com/adaptlearning/adapt-cli), run the following from the command line:\n`adapt install adapt-contrib-instructionError`\n\n* This extension can also be installed by adding the following line of code to the *adapt.json* file:\n    `\"adapt-contrib-instructionError\": \"*\"`\n    Then running the command:\n    `adapt install`\n    (This second method will reinstall all plug-ins listed in *adapt.json*.)\n\n* If **Instruction Error** needs to be installed in the Adapt authoring tool, it may be installed by uploading the zip.\n\n## Settings\n\n### *course.json*\n\nThe following attributes, set within *course.json*, configure the defaults for **Instruction Error**.\n\n**\\_instructionError** (object): The Instruction Error attributes group contains values for **\\_isEnabled**, **\\_showAsPopup**, **title** and **body**.\n\n\u003e**\\_isEnabled** (boolean): Turns on and off the **Instruction Error** extension.\n\n\u003e**\\_showAsPopup** (boolean): When set to `true`, the **Instruction Error** will display the error in a notify popup. The default is `false`.\n\n\u003e**title** (boolean): When using the `_showAsPopup` option, this is the notify title for the instruction error. Otherwise, this is not used.\n\n\u003e**body** (boolean): When using the `_showAsPopup` option, this is the notify body for the instruction error. Otherwise, this replaces the existing `.component__instruction` text. Defaults to the question instruction text. If instruction text is not set, a generic message is used.\n\n## Limitations\n\nNo known limitations.\n\n----------------------------\n**Author / maintainer:** Adapt Core Team with [contributors](https://github.com/adaptlearning/adapt-contrib-tutor/graphs/contributors)\u003cbr\u003e\n**Accessibility support:** WAI AA\u003cbr\u003e\n**RTL support:** Yes\u003cbr\u003e\n**Cross-platform coverage:** Chrome, Chrome for Android, Firefox (ESR + latest version), Edge, Safari for macOS/iOS/iPadOS, Opera\u003cbr\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadaptlearning%2Fadapt-contrib-instructionerror","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadaptlearning%2Fadapt-contrib-instructionerror","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadaptlearning%2Fadapt-contrib-instructionerror/lists"}