@vitalsource/a11y-panel

a11y-panel is a collaborative project designed to fetch and display accessibility claims in a standardized UI.

Getting Started

Set up nvm

If you aren't already using it, set up nvm, which manages per-project node/npm versions. It may be helpful to uninstall your global version to avoid accidental use.

Installation

Download

To install a11y-panel, run one of the following from the command line. Make sure to look at the output, and install any missing peer dependencies.

npm install @vitalsource/a11y-panel
# don't forget to install any missing peer dependencies!

or

yarn add @vitalsource/a11y-panel
# don't forget to install any missing peer dependencies!

Install Dependencies

npm ci

Run the dev server

npm start

This will start a local development launch page at http://localhost:8787

Usage

Module

import { a11yPanel } from '@vitalsource/a11y-panel';

// Options for rendering
const options = {
  vbid: '1234567890', //required
  locale: 'en-US', //optional - en-US fallback
  theme: 'ocean', //optional - ocean fallback
};

// Render A11yPanel Component
const panelHTML = a11yPanel(options);

// Insert a11y-panel into your application
return panelHTML;

Webview/IFrame

const prodURL = "https://a11y-panel.vitalsource.com";
const devURL = "https://a11y-panel-develop.vitalsource.com";

<iframe 
  src="${workerURL}?vbid=1234567890&locale=en-US&theme=ocean"
  width="100%" 
  height="100%" 
  frameborder="0" 
  allowfullscreen>
</iframe>

Contributing

If you'd like to help out with future updates, please see the contribution guidelines.

Reference

...

vst-ui-kit

vst-ui-kit has been transitioned to own standalone NPM Module @vitalsource/vst-ui-ki. No formal github repository has been created as of yet so please reach out to the Bookshelf Online / Otter Team for necessary changes.

What languages does A11yPanel support?

|Language|Long Code|Short Code| |-|-|-| | Arabic (Saudi Arabia) | ar-SA | ar | | Bulgarian (Bulgaria) | bg-BG | bg | | Catalan (Spain) | ca-ES | ca | | Czech (Czech Republic) | cs-CZ | cs | | Welsh (United Kingdom) | cy-GB | cy | | Danish (Denmark) | da-DK | da | | German (Germany) | de-DE | de | | Greek (Greece) | el-GR | el | | English (United Kingdom) | en-GB | en-GB | | English (United States) | en-US | en | | Spanish (Spain) | es-ES | es | | Spanish (Latin America) | es-LA | es-LA | | Spanish (Mexico) | es-MX | es-MX | | Finnish (Finland) | fi-FI | fi | | French (Canada) | fr-CA | fr-CA | | French (France) | fr-FR | fr | | Gaelic (Ireland) | ga-IE | ga | | Hebrew (Israel) | he-IL | he | | Hindi (India) | hi-IN | hi | | Hungarian (Hungary) | hu-HU | hu | | Icelandic (Iceland) | is-IS | is | | Italian (Italy) | it-IT | it | | Japanese (Japan) | ja-JP | ja | | Korean (Korea) | ko-KR | ko | | Norwegian (Norway) | nb-NO | nb | | Dutch (Netherlands) | nl-NL | nl | | Polish (Poland) | pl-PL | pl | | Portuguese (Brazil) | pt-BR | pt-BR | | Portuguese (Portugal) | pt-PT | pt | | Romanian (Romania) | ro-RO | ro | | Russian (Russia) | ru-RU | ru | | Swedish (Sweden) | sv-SE | sv | | Thai (Thailand) | th-TH | th | | Tagalog (Philippines) | tl-PH | tl | | Turkish (Turkey) | tr-TR | tr | | Vietnamese (Viet Nam) | vi-VN | vi | | Chinese (Simplified) | zh-CN | zh | | Chinese (Traditional) | zh-TW | zh-TW |