Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

accessibility-options

stoque23MIT1.0.4

Accessibility Bar plugin.

readme

Accessibility Bar

Accessibility Bar plugin.

Features

  • Buttons to Increment/Decrement font size
  • Button to toggle high-contrast version based on body class
  • Button to LIBRAS (Língua brasileira de sinais)

Quick Start

Install

Download the latest release.

Config

Add script with minified file

<script type="text/javascript" src="vendor/accessibility/accessibility.js"></script>

Create markup with data-accessibility in buttons, example:

<ul class="list">
    <li class="item">
        <button class="action" type="button" data-accessibility="font-decrease">
            A-
        </button>
    </li>
    <li class="item">
        <button class="action" type="button" data-accessibility="font-increase">
            A+
        </button>
    </li>
    <li class="item">
        <button class="action" type="button" data-accessibility="contrast">
          Contrast
        </button>
    </li>
    <li class="item">
        <a class="link" target="_blank" href="http://www.vlibras.gov.br/">
          VLIBRAS
        </a>
    </li>
</ul>

(optional) Add link for css file

<link rel="stylesheet" href="vendor/accessibility/accessibility.css">

Use

Call the plugin function

Accesibility.init();

Options

Make some customizations

Accessibility.init({
  fontIncrement: 2,
  fontIncrementLimit: 2,
  contrastClass: 'color-inverter'
})
Key Description Type Default
contrastClass Define a custom class name for high contrast version string color-inverter
fontIncrementLimit Define a custom maximum click for font adjust integer 2
fontIncrement Define a custom increment rate for font adjust integer 2