Skip to content
/ easyWai Public

A small and simple jquery plugin for accessibility component

Notifications You must be signed in to change notification settings

ronka/easyWai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

easyWai - v1.1.0 - Demo.

Features

  • Increase Font
  • Decrease Font
  • Readable Font
  • Monochrome
  • High Contrast
  • Low Contrast
  • Light Background
  • Highlight Links
  • Accessibility Statment
  • Skip Content Button
  • Save the settings choosen in cookie

Required Files

Add the css file and the js file, requires jquery installed

<link rel="stylesheet" href="easywai.css">
<script src="easywai.js"></script>

How to use

$.easyWai({
    fade: true,
    position: {
        top: '60px',
        side: 'left',
    },
    features:{
        readableFont: 'פונט מאוד קריא'
        monochrome: false,
    },
    saveSettings: true,
    skipContent: '#main',
    accStatement: {
        url: '#'
    }
});
How to call the methods outside of the plugin
window.easyWai.methods.monochrome(); // turn monochrome mode on
window.easyWai.methods.reset(); // reset all the settings

Settings

Name Description
position:side Set the side of the accessibility menu, default right
position:top Distance of the accessibility menu from top, drfault 20px
features increaseFont,decreaseFont,readableFont,monochrome,highContrast,lowContrast,lightBG,highlightLinks, false to hide, string to change the text
accStatement:text Accessibility statment button text, default "הצהרת נגישות"
accStatement:url Accessibility statment url link, set false to hide
customIcon pass html element to replace the icon, default font-awesome icon
skipContent css selector to main content, default false
fade if set to true, the menu will apper in a fade, default false
saveSettings if set to true, user settings will be saved in a cookie for later visits

About

A small and simple jquery plugin for accessibility component

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published