https://github.com/instructure/tinymce-a11y-checker

An accessibility checker plugin for TinyMCE.
https://github.com/instructure/tinymce-a11y-checker

a11y canvas-lms tinymce

Last synced: 7 days ago
JSON representation

An accessibility checker plugin for TinyMCE.

• Host: GitHub
• URL: https://github.com/instructure/tinymce-a11y-checker
• Owner: instructure
• License: mit
• Created: 2017-10-26T20:59:51.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-26T20:42:00.000Z (5 months ago)
• Last Synced: 2024-06-27T00:57:00.448Z (5 months ago)
• Topics: a11y, canvas-lms, tinymce
• Language: JavaScript
• Homepage: https://instructure.github.io/tinymce-a11y-checker/
• Size: 35.3 MB
• Stars: 22
• Watchers: 17
• Forks: 18
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# TinyMCE Accessibility Checker Plugin _(tinymce-a11y-checker)_

## Deprecated

This package had been merged into `@instructure/canvas-rce`. This repository

is no longer under development or being maintained.

The corresponding npm package has been deprecated.

If you use the Rich Content Editor from Canvas, the a11y checker is now

built in.

---

> An accessibility checker plugin for TinyMCE.

[![Build Status](https://travis-ci.com/instructure/tinymce-a11y-checker.svg?branch=master)](https://travis-ci.com/instructure/tinymce-a11y-checker)

[![npm](https://img.shields.io/npm/v/tinymce-a11y-checker.svg)](https://www.npmjs.com/package/tinymce-a11y-checker)

## Install

You will need to have an instance of TinyMCE setup prior to using this plugin.

```bash

npm install tinymce-a11y-checker --save

# or

yarn add tinymce-a11y-checker

```

## Usage

```js

import tinymce from "tinymce"

import "tinymce-a11y-checker"

tinymce.init({

  selector: "#editor",

  plugins: ["a11y_checker"],

  toolbar: "check_a11y | bold italic ...",

})

```

## Contribute

See [the contributing file](CONTRIBUTING.md)!

PRs accepted.

[MIT](../LICENSE)