Neutral Political Machine

    jquery-screenreader-trap

    1.0.1 • Public • Published

    jquery-screenreader-trap

    Build Status Coverage Status Dependency status devDependency status

    ATTENTION: A non-jQuery version is now available at makeup-screenreader-trap.

    Prevents screen reader's virtual cursor from leaving the confines of a containing element.

    Screenreader-trap is a singleton as there can only ever be one active screenreader-trap on a page. Creating a new screenreader-trap will disable the current trap.

    $.trapScreenreader($containerEl);
    $.untrapScreenreader();

    Install

    npm install jquery-screenreader-trap

    Events

    • screenreaderTrap : fired when screenreader trap is activated
    • screenreaderUntrap : fired when screenreader trap is deactivated

    Dependencies

    Development

    Run npm start for test driven development. All tests are located in test.js.

    Execute npm run to view all available CLI scripts:

    • npm start test driven development: watches code and re-tests after any change
    • npm test runs tests & generates reports (see reports section below)
    • npm run lint lints code for syntax and style
    • npm run fix attempts to auto fix style errors
    • npm run minify builds minified version of code
    • npm run jsdoc generates jsdocs
    • npm run build minifies code and generates jsdocs
    • npm run clean deletes all generated files

    The following hooks exist, and do not need to be invoked manually:

    • npm prepublish cleans, lints, tests and builds on every npm publish command
    • pre-commit cleans, lints, tests and builds on every git commit command

    Test Reports

    Each test run will generate the following reports:

    • /test_reports/coverage contains Istanbul code coverage report
    • /test_reports/html contains HTML test report
    • /test_reports/junit contains JUnit test report

    JSDocs

    JSDocs are generated under ./jsdoc folder.

    CI Build

    https://travis-ci.org/makeup-jquery/jquery-screenreader-trap

    Code Coverage

    https://coveralls.io/github/makeup-jquery/jquery-screenreader-trap?branch=master

    Install

    npm i jquery-screenreader-trap

    DownloadsWeekly Downloads

    5

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • ianmcburnie