New: Add option to disable popup and show error inline (fixes #12)

[swashbuck]

Fixes #12

New

• Adds _showAsPopup option to enable the instruction error popup. When false (and by default), the error is shown inline instead.

Dependencies

adaptlearning/adapt-contrib-core#593 ✅ Merged
adaptlearning/adapt-contrib-core#595 ✅ Merged

Testing

1. In course.json, disable error popups as follows:

"_instructionError": {
    "_isEnabled": true,
    "_showAsPopup": false,
    "title": "Instructions",
    "body": "{{#if instruction}}{{{instruction}}}{{else}}Please complete the question and then select Submit.{{/if}}"
}

2. Click on a question's Submit button before it is ready for submission (ex. an MCQ item choice has not been made)

Expected result

The instruction text is highlighted.

[swashbuck]

@kirsty-hames Will you have a look at this and let me know what you think? I'm especially interested on your thoughts on accessibility of the solution (ex. should we use an aria-live attribute, etc). Thanks!

[swashbuck]

Probably out of scope for this issue...

Definitely out of scope. Would be relatively easy to do with that component level class.

Created #14 for this.

[kirsty-hames]

This works well thanks @swashbuck. I've added some notes to an earlier comment querying the use of aria-live. There's good reasoning for your implementation so unless we hear otherwise I don't think aria-live is necessary.

[swashbuck]

This works well thanks @swashbuck. I've added some notes to an earlier comment querying the use of aria-live. There's good reasoning for your implementation so unless we hear otherwise I don't think aria-live is necessary.

Thanks, @kirsty-hames !

[swashbuck]

It wonder if we should move the 'has-error` code into core so that the components can implement their own error styling?

@oliverfoster @kirsty-hames I'm going to create a Core PR for this per the discussion in #14 .

Update: created adaptlearning/adapt-contrib-core#594

[kirsty-hames]

Retested with core PRs #593 and #595 and works as expected thanks 👍

[cahirodoherty-learningpool]

👀

[oliverfoster]

Version bump now required @swashbuck

[github-actions]

🎉 This PR is included in version 2.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀