rgb-color-is-dark

Determine if a color in RGB format is dark using YIQ calculation

Description

Determine if a colour is dark using the YIQ calculation.

See...

• Install/Usage
• Types
• Syntax
• Examples
• See Also

Install

npm install --save @chriscodesthings/rgb-color-is-dark

Usage

import rgbColorIsDark from '@chriscodesthings/rgb-color-is-dark';

console.log(rgbColorIsDark([100, 149, 237])); // cornflowerblue
// => false

Types

This package uses types from:

• basic-color-types: Defines named types for common color formats

Syntax

rgbColorIsDark([r, g, b, (a)]);

Parameters

• r, g, b: Red, green and blue color components
• a (optional): Alpha value is ignored if present

Return Value

Returns boolean true if color is dark based on YIQ calculation, false otherwise.

Examples

// get contrasting text colour for a given background colour
function getTextColourForBackground(r, g, b) {
    if( rgbColorIsDark([r, g, b])) {
        // colour is dark, return white
        return [255, 255, 255];
    }

    // colour is light, return black
    return [0, 0, 0];
} 

See Also...

• Calculating Color Contrast
• rgb-color-yiq-value: Function to calculate the YIQ value of a color in RGB format
• color-object: Simple, lightweight class to store and manipulate a color, and convert between formats
• random-css-hex-color: Generates a random color in CSS hex format