Skip to content

Latest commit

 

History

History
190 lines (144 loc) · 7.49 KB

README.md

File metadata and controls

190 lines (144 loc) · 7.49 KB

Node.js CI

GitLab pipeline status js-semistandard-style GAAD-widget - on Npmjs License Total downloads - on NPMJS Size of Javascript Vulnerability test Accessibility test - GAAD passes gaad-widget - on UNPKG

gaad-widget

Display a banner-link to promote Global Accessibility Awareness Day (GAAD). The banner displays for a configurable period before and after the day, and the emphasis is on easy site-integration, via a CDN.

Global Accessibility Awareness Day

Join us on Thursday, May 16 2019 and mark the eighth Global Accessibility Awareness Day (GAAD). The purpose of GAAD is to get everyone talking, thinking and learning about digital (web, software, mobile, etc.) access/inclusion and people with different disabilities.

Read the blog post. Built on Datejs (API).

Note ~ this is not an official widget!

Original Gist.

Release notes

Features

Install and test

npm i gaad-widget
npm run build
npm test

Usage

Via unpkgbrowse — production CDN:

<div id="id-gaad-widget"></div>

<script src="https://unpkg.com/gaad-widget@^3#"></script>

Local hosting:

<div id="id-gaad-widget"></div>

<script src="dist/gaad-widget.js" ></script>

See the list of default configuration options.

Setting the days_before option:

<div id="id-gaad-widget"></div>

<script src="dist/gaad-widget.js" data-gaad-widget='{ "days_before": 20 }'></script>

Setting several configuration options:

<div id="custom_id"></div>

<script
  src="dist/gaad-widget.js"
  data-gaad-widget='{ "id": "custom_id", "days_after": 10, "theme": "black", "debug": true }'
  ></script>

Analytics

Anonymous usage statistics via Google Analytics is being added for version 3.2+ (> 3.1.0). It will be enabled by default, and can be disabled thus:

<div id="id-gaad-widget"></div>

<script src="dist/gaad-widget.js" data-gaad-widget='{ "analytics": null }'></script>

Translation

Please help with translating gaad-widget into your language!

Français (French):

<div id="id-gaad-widget"></div>

<script src="dist/gaad-widget.js" data-gaad-widget='{ "lang": "fr" }' ></script>

WordPress

A plugin for WordPress.

License

License: MIT.

Twitter: @nfreear, @gbla11yday.

See the related isad-widget.