Code Monkey home page Code Monkey logo

markdown-it-code-tabindex's Introduction

markdown-it-code-tabindex

Add tabindex="0" to your fenced code blocks in markdown-it for keyboard accessibility.

Installation

npm i markdown-it-code-tabindex

Usage

Refer to the markdown-it docs on loading plugins.

Options

Name Description Type Default
target The HTML tag on which to set tabindex="0" for fenced code blocks. Either one is fine, so long as you pick the right one based on your CSS. 'pre'|'code' 'pre'

Examples

Basic usage

const markdownIt = require('markdown-it');
const markdownItTabIndex = require('markdown-it-code-tabindex');

const md = markdownIt().use(markdownItTabIndex, {
  target: 'code', // or 'pre'
});

Usage with other plugins

const markdownIt = require('markdown-it');
const markdownItAttributes = require('markdown-it-attrs');
const markdownItPrism = require('markdown-it-prism');
const markdownItCodeTabIndex = require('markdown-it-code-tabindex');

const md = 
  markdownIt()
  .use(markdownItPrism)
  .use(markdownItAttributes)
  // Order does not matter; this could go before other plugins
  .use(markdownItCodeTabIndex, { target: 'code' });

Motivation

There are two ways to handle long lines of text in fenced code blocks (and in general):

  1. Allow whitespace to wrap to the next line whenever the current line would overflow.
  2. Prevent whitespace from wrapping and set overflow-x: auto on your code block.

Which one you choose comes down to personal preference, but scrollable code blocks tend to be more common. However, there is one drawback to this approach: Scroll regions are not accessible to keyboard users unless they are focusable. And the only way to make them focusable is to set tabindex="0" on those scroll containers. However, there isn't a straightforward way to do this in Markdown.

This plugin automatically adds tabindex="0" to all of your fenced code blocks in markdown-it. It does not modify inline code, nor does it remove or modify any other HTML attributes.

Compatibility with Other markdown-it Plugins

This plugin is compatible with the following markdown-it plugins:

The order in which you load these plugins does not matter.

markdown-it-code-tabindex's People

Contributors

aleksandrhovhannisyan 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.