Never Propel Marmalade

    get-relative-luminance

    1.0.0 • Public • Published

    Get relative luminance

    Dependabot Status

    get-relative-luminance calculates a CSS color's relative luminance based on this definition from W3C.

    It doesn't handle transparency as of yet.

    Installation

    $ npm install get-relative-luminance
    

    Usage

    import getRelativeLuminance from 'get-relative-luminance';
     
    getRelativeLuminance('rgb(255, 255, 255)'); // 1
    getRelativeLuminance('white'); // 1
    getRelativeLuminance('hsl(0, 0%, 0%)'); // 0

    Signature

    (color: string, { ignoreTransparency:boolean = false } = {}) => number

    Contributing

    I appreciate your issues and PRs on Github!

    Testing

    yarn build && yarn test
    

    Releasing

    This project uses np.

    1. Make sure your changes are in master
    2. Run yarn release
    3. Follow the interactive release guide

    Install

    npm i get-relative-luminance

    DownloadsWeekly Downloads

    1,636

    Version

    1.0.0

    License

    GPL-3.0

    Unpacked Size

    8.53 kB

    Total Files

    12

    Last publish

    Collaborators

    • misund