@colorblender/a11y v1.0.2

Installation

This package require colorblender to work.

npm install @colorblender/a11y

Import

import { colorblender, extend } from 'colorblender';
import { a11yExtension } from '@colorblender/a11y';

extend([a11yExtension]);

Usage

Create colorblender instance

colorblender({ r: 0, g: 0, b: 0 });
colorblender({ r: 0, g: 0, b: 0, a: 1 });

Methods

Analysis

colorblender({ r: 167, g: 40, b: 13 }).luminosity(); // 0.0976213184127798

colorblender({ r: 167, g: 40, b: 13 }).contrast({ r: 28, g: 252, b: 185 }); // 5.308885390786212

interface ReadabilityOptions {
  level?: 'AA' | 'AAA';
  size?: 'normal' | 'large';
}

colorblender({ r: 167, g: 40, b: 13 }).isReadable(
  { r: 28, g: 252, b: 185 },
  {
    level: 'AAA',
    size: 'large',
  },
); // true

Issues

Please file an issue for bugs, missing documentation, or unexpected behavior.

File an issue

License

MIT