@oat-sa/tao-test-runner-qti/src/plugins/content/accessibility/jumplinks/jumplinks.js

TAO Test Runner QTI implementation

/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2020 (original work) Open Assessment Technologies SA ;
 */

/**
 * The jumplinks bsx manages accessibility feature "jumplinks"
 *
 *  @author aliaksandr paliakou <lecosson@gmail.com>
 */
import _ from 'lodash';
import component from 'ui/component';
import jumplinksTpl from 'taoQtiTest/runner/plugins/content/accessibility/jumplinks/jumplinks.tpl';

/**
 * Default config values, see below.
 */
const defaults = {
};

/**
 * Creates and initialize the jumplinks component.
 * Please not the component IS NOT rendered.
 * You'll have to render it by yourself.
 *
 * @returns {jumplinks} the component, initialized and rendered
 */
export default function jumplinksFactory(config) {

    /**
     * @typedef {Object} jumplinksBox
     */
    const jumplinksBox = component({}, defaults)
        .on('render', function() {
            // handle related Jump Links
            const behavior = [{
                selector: '[data-jump=question] ',
                eventName: 'jump',
                eventParam: 'question',
            }, {
                selector: '[data-jump=navigation]',
                eventName: 'jump',
                eventParam: 'navigation',
            }, {
                selector: '[data-jump=toolbox]',
                eventName: 'jump',
                eventParam: 'toolbox',
            }, {
                selector: '[data-jump=teststatus]',
                eventName: 'jump',
                eventParam: 'teststatus',
            }, {
                selector: '[data-jump=shortcuts]',
                eventName: 'shortcuts',
                eventParam: 'shortcuts',
            }];
            _.forEach(behavior, (linkDescription) => {
                const $link = this.getElement().find(linkDescription.selector);
                const handleLink = () => {
                    this.trigger(linkDescription.eventName, linkDescription.eventParam);
                    this.getElement().find(':focus').blur();
                };
                if ($link) {
                    $link.on('click', handleLink);
                    $link.on('keyup', (event) => {
                        const activationKeys = [32, 13]; // link can be activated by click or enter/space keys
                        if (activationKeys.includes(event.keyCode)) {
                            handleLink();
                        }
                    });
                }
            });
        });


    jumplinksBox.setTemplate(jumplinksTpl);

    _.defer(() => {
        jumplinksBox.init(config);
    });

    return jumplinksBox;
}