no-mouse-days

    0.0.4 • Public • Published

    No Mouse Days

    Ever wanted a package that disables the mouse cursor one day a week so you can test keyboard accessibility as a team? No? Well here you go anyway.

    This package can be installed into a modern JavaScript app to inject a CSS styling developer tool that disables the mouse cursor, with a banner to notify developers of its use. It's intended to encourage development of better keyboard support through regular browser testing (you are testing, aren't you?).

    Read about No Mouse Days on the Accessibility Project: https://www.a11yproject.com/posts/2020-10-15-no-mouse-days

    Prerequisites

    • Node.js
    • npm

    How to use

    1. Install the package
    npm install no-mouse-days --save-dev
    1. Import the package into your project for all times
    import "no-mouse-days"
    1. Import and conditionally apply it in development, if you want
    if (process.env.NODE_ENV === 'development') {
        import("no-mouse-days")
            .then((data) => {
             // no-op
            })
    }
    1. Or apply it one day of the week, e.g. on Mondays
    let date = new Date()
    let dayOfWeek = date.getDay()
     
    if (dayOfWeek === 1) {
        import("no-mouse-days")
            .then((data) => {
             // no-op
            })
    }

    Example

    This project includes a small example that you can use to test the No Mouse Days script locally in a browser.

    Go into the example directory and install dependencies:

    cd example
    npm start
    

    With a server successfully running, you can then visit the provided localhost URL such as http://localhost:1234.

    You can also view the example on GitHub pages: https://marcysutton.github.io/no-mouse-days/example/index.html

    Keywords

    none

    Install

    npm i no-mouse-days

    DownloadsWeekly Downloads

    3,340

    Version

    0.0.4

    License

    ISC

    Unpacked Size

    4.83 kB

    Total Files

    6

    Last publish

    Collaborators

    • marcysutton