Giter Site home page Giter Site logo

jimmi08 / button-visually-impaired-javascript Goto Github PK

View Code? Open in Web Editor NEW

This project forked from veks/button-visually-impaired-javascript

0.0 0.0 0.0 3.76 MB

Button visually impaired

Home Page: http://bvi.isvek.ru/demo/

License: MIT License

JavaScript 56.72% HTML 17.53% SCSS 25.75%

button-visually-impaired-javascript's Introduction

Button visually impaired

Button visually impaired - is a plugin that automatically changes the visually impaired version of your site. The panel on the site for the visually impaired allows the color scheme of the site, font sizes, the synthesizer reads aloud settings changes. Thanks to it, you can use the functions of the site that meet the needs of people with disabilities.

  • Change the font size (up to 200%);
  • Change the color scheme of the site;
  • Change the font of the site (serif or sans serif);
  • Change the image (gray scale, hide the image);
  • Change letter spacing (kerning);
  • Change line spacing;
  • Automatically set Alt tag to all site images;
  • Speech synthesizer will read aloud changes to display settings;
  • Disable embedded elements (videos, maps, etc.);
  • Play text to voice;
  • Support for browsers Chrome, Firefox, Safari, Microsoft Edge, Opera;

Demo

view demo version here.

NPM

$ npm install bvi
import bvi from "bvi"

Browser Usage

Download the latest package. unpack and inspect the contents. You need to copy the bvi.min.js and bvi.min.css or their minified variations to your app dist folders as follows. Link the required CSS in your document <head> tag

<link href="dist/css/bvi.min.css" rel="stylesheet">

Link the required JS in your document at the end of the pages, right before the closing </body> tag

<script src="dist/js/bvi.min.js"></script>

Run function with default settings

<script>
  new isvek.Bvi();
</script>

Run function with your settings

<script>
  new isvek.Bvi({
    target: '.className',
    fontSize: 24,
    theme: 'black'
    //...etc
  });
</script>

Html class

Arbitrary links

<a href="#" class="className">version for visually impaired</a>

Speech synthesis

<div class="bvi-speech">
  Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's
  standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a
  type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining
  essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum
  passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
</div>

Hide element

<div class="bvi-hide">The text will be hidden when the plugin is enabled.</div>

Show element

<div class="bvi-show">The text will be shown when the plugin is enabled.</div>

Disable styles div block

<div class="bvi-no-styles">Plugin styles will not be applied in this block.</div>

Settings

Option Type Default value Value options Description
target string '.bvi-open' '.className' Plugin initialization class
fontSize number 16 1-39 Font size
theme string 'white' (white|black|blue|brown|green) Color spectrum
images (string|boolean) 'grayscale' (true|false|grayscale) Adapting images
letterSpacing string 'normal' (normal|average|big) Letter spacing
lineHeight string 'normal' (normal|average|big) Line spacing
speech boolean true (true|false) Speech synthesis
fontFamily string 'arial' (arial|times) Fonts
builtElements boolean false (true|false) Inline elements are a component of an HTML element that allows you to embed documents, videos, maps, and interactive media into a page.
panelFixed boolean true (true|false) Fixing the panel for the visually impaired at the top of the page.
panelHide boolean false (true|false) Hides the panel for the visually impaired and shows the panel icon.
reload boolean false (true|false) Enable / Disable page reload when switching to the regular version of the site.
lang string 'ru-RU' ('ru-RU'|'en-US') Language

Changelog

1.0.0

  • new version created JavaScript

License

MIT License

button-visually-impaired-javascript's People

Contributors

veks avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.