https://github.com/alex-page/a11ycolor

🌈 Generate the nearest accessible color
https://github.com/alex-page/a11ycolor

a11y accessibility color contrast contrast-ratio javascript npm

Last synced: about 2 months ago
JSON representation

🌈 Generate the nearest accessible color

• Host: GitHub
• URL: https://github.com/alex-page/a11ycolor
• Owner: alex-page
• License: mit
• Created: 2017-12-04T07:08:51.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2023-07-20T02:39:45.000Z (over 1 year ago)
• Last Synced: 2024-10-12T23:15:20.078Z (2 months ago)
• Topics: a11y, accessibility, color, contrast, contrast-ratio, javascript, npm
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/a11ycolor
• Size: 745 KB
• Stars: 36
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🌈 A11yColor

> Generate the nearest accessible color.

## Install

```console

$ npm install a11ycolor

```

## Usage

```js

const a11yColor = require('a11ycolor');

a11yColor(red, blue); // This returns #FFA3A3

```

## Parameters

The function `a11yColor` function takes three parameters:

```js

a11yColor($toMakeA11y, $background, ($ratioKey = 'small'));

```

1. `toMakeA11y` - The color that is to be made accessible on the background

1. `background` - The background color to for the contrast

1. `ratioKey` - The keyword 'small' ( 4.5 ) or 'large' ( 3.0 ) for the WCAG 2.1 contrast ratio

## Release History

- v2.0.9 - Update GitHub action to use yml syntax

- v2.0.8 - Update dependencies

- v2.0.7 - Update dependencies

- v2.0.6 - Replace `eslint` with `xo`, adjust formatting

- v2.0.5 - Use files instead of `.npmignore`

- v2.0.4 - Remove `prepublishOnly` script

- v2.0.3 - Remove travis badge from README.md

- v2.0.2 - Replace travis with GitHub actions

- v2.0.1 - Updating readme, fixing bug when white and black passes

- v2.0.0 - Binary search, removing steps, adding eslint

- v1.1.0 - Fixing bugs that caused the contrast to be off by 0.2

- v1.0.7 - Adding travis

- v1.0.6 - Minimizing the files

- v1.0.5 - Removing babel

- v1.0.4 - Updating documentation

- v1.0.3 - Making import work

- v1.0.2 - Removing unecessary NPM packages

- v1.0.1 - Adding readme

- v1.0.0 - First release