1.0.2 • Published 5 years ago

thebility v1.0.2

Weekly downloads
2
License
LGPL-3.0
Repository
github
Last release
5 years ago

THEbility

JS Accessibility Plugin

Getting Started

option 1 : //npm

npm i thebility --save-dev

How to use

const thebility = require('thebility');

    let options = {
      textCol: "#b7b7b7", //text-color
      bgCol: "rgba(50, 50, 51, 0.9)", //main div bg color
      borCol: "#94000F", //main div border color
      btnBgCol: "#323233", //buttons div border color
      trackBgCol: "rgba(148, 0, 15, 0.7)", //tracks color1
      rangeBgCol: "rgba(181, 0, 10, 0.7)", //tracks color1
      font: "./Heebo-Medium.ttf", //path to font
      fontSize: "1.8vh" //font-size
        };  

   thebility.THEbility(options);

option 2: //HTML embeding

1. Download the BrowserDist folder
2. <script src="/path/to/thebility.js</script>
<!-- the icons folder should be in the same folder as the js file --> 
 

How to use

    let options = {
      textCol: "#b7b7b7", //text-color
      bgCol: "rgba(50, 50, 51, 0.9)", //main div bg color
      borCol: "#94000F", //main div border color
      btnBgCol: "#323233", //buttons div border color
      trackBgCol: "rgba(148, 0, 15, 0.7)", //tracks color1
      rangeBgCol: "rgba(181, 0, 10, 0.7)", //tracks color1
      font: "./Heebo-Medium.ttf", //path to font
      fontSize: "1.8vh" //font-size
        };
             
        /*more customisations can be done by editing the css.js file*/        

    The language set's according to <HTML> tag's "lang" value. The languages object is in the loc.js file. To add language add new key named with the 2 letters language code. Currently EN and HE exists in the build. 

    new THEbility(options);

Language Notice

The language set's according to HTML tag's "lang" value. The languages object is in the loc.js file for the browser build or in the node_modules/thebility/NpmDist/thebility.js for the npm build. To add language add new key named with the 2 letters language code. Currently EN and HE exists in the build.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the LGPL License - see the LICENSE.md file for details