cgkineo / adapt-definitions

Glossary - Popup word definitions

adapt-definitions

course.json

    "_definitions": {
        "_isEnabled": true,
        "title": "Definition",
        "body": "{{{word}}}: {{{definition}}}",
        "confirmText": "Close",
        "_showIcon": true
    }

any json - single instance definition

    {
        "body": "This next <span role='button' tabindex='0' definition='Has a brief description'>word</span>"
    }

course.json - global definition for every word occurance

    "_definitions": {
        "_isEnabled": true,
        "title": "Definition",
        "body": "{{{word}}}: {{{definition}}}",
        "confirmText": "Close",
        "_showIcon": true,
        "_items": [
            {
                "words": [
                    "sam"
                ],
                "definition": "This is the sun of Sam"
            },
            {
                "words": [
                    "Adapt Framework"
                ],
                "definition": "This is a piece of software which</br>allows you to create e-learning."
            },
            {
                "words": [
                    "Adapt"
                ],
                "definition": "This is a community of people"
            },
            {
                "words": [
                    "the",
                    "a"
                ],
                "definition": "Excellent word this one"
            }
        ]
    } 

adapt-definitions's Issues

can probably fix this using code from visua11y bionic read

Subject of the issue

bionic read code https://github.com/cgkineo/adapt-visua11y/pull/82/files#diff-b8eb2781765696671082ea4abb0fe505450fd312f39646d55ed86a9048f7b2c7

a11y_text is no longer used or supported, the above code is an alternative way of inspected added text

v4 Adapt doesn't have a11y text so global definitions are broken

Accessibility. Tabbing and using the keyboard

Suggest adding

(to to the initialize function)

         $('body').on('keyup', "[definition]", e => {
              if (e.which !== 13 ) return;
              this.onAbbrClick(e);
            });

To capture the enter key for accessibility.

This plug-in could also do with some updates generally to make accessibility easier to mark-up in the JSON.