Giter Site home page Giter Site logo

a1ip / olli Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mitvis/olli

0.0 1.0 0.0 2.29 MB

A library for converting web visualizations into accessible text structures for blind and low-vision screen reader users.

License: BSD 3-Clause "New" or "Revised" License

JavaScript 2.46% TypeScript 96.24% CSS 1.30%

olli's Introduction

Olli - Screen Reader Accessibility for Data Visualization

Olli is an open-source library for converting data visualizations into accessible text structures for screen reader users. Starting with an existing visualization specification created with a supported toolkit, Olli produces a keyboard-navigable tree view with descriptions at varying levels of detail. Users can explore these structures both to get an initial overview, and to dive into the data in more detail.

Using Olli

For a user tutorial, quickstart guide, and examples, see the Olli website.

Development instructions

  • Fork and clone the mitvis/olli repository.
  • In the olli directory, run npm install to install dependencies for all packages. We use npm workspaces to manage the two packages in this repo.
  • In the core or adapters package directories, run npm run start to start the webpack bundler in development mode with live reloading. Run npm run build to run webpack for production. (Note: olli must be built before olli-adapters the first time you run the build scripts.)
  • To run scripts for both packages at the same time, run commands from the olli directory using the -ws flag, e.g. npm run build -ws.

Current Visualization Library Support

Related Links

Reporting an Issue

If you encounter issues when using Olli, please file an issue on GitHub. Please include enough information to reproduce the issue. For example, if the issue is a bug with a chart that Olli should support with one of its adapters, please include the spec and dataset for the chart. For accessibility issues, please share what browser and screen reader you are using.

Contributions, Development, and Support

Interested in contributing to Olli? Please see our contribution and development guidelines, and our code of conduct.

Olli was originally created by Matt Blanco and the library is maintained by the MIT Visualization Group.

olli's People

Contributors

dependabot[bot] avatar jonathanzong avatar joshpoll avatar matt-blanco avatar

Watchers

 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.