1.0.0 • Published 8 years ago

@f/rgba v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
8 years ago

rgba

Build status Git tag NPM version Code style

RGBA string generator

Installation

$ npm install @f/rgba

Usage

Generates an RGBA string given almost any reasonable input. You can pass regular RGBA values, color names, hex codes, and even other color encodings (e.g. HSV/HSL/HWB).

var rgba = require('@f/rgba')

rgba(128, 30, 57, 0.20)        === 'rgba(128, 30, 57, 0.20)'
rgba('#FFEEFF', '20%')         === 'rgba(255, 238, 255, 0.20)'
rgba('salmon', 0.20)           === 'rgba(250, 128, 114, 0.20)'
rgba('hsl(214, 1, 0.5)', 0.75) === 'rgba(0, 110, 255, 0.50)'
rgba('hsla(214, 1, 0.5, 0.75)') === 'rgba(0, 110, 255, 0.50)'
rgba('hsv(74, 0.19, 0.41)')    === 'rgba(100, 105, 85, 1)'
rgba('hwb(87, 0.27, 0.5)')     === 'rgba(101, 128, 69, 1)'

Which color encodings are supported?

API

rgba has two different signatures, depending on how many arguments are passed:

rgba(color, alpha)

  • color - The color, specified as one of the allowed encodings listed above.
  • alpha - Optional opacity, defaults to 1.

rgba(red, green, blue, alpha)

  • red - red, scaled between 0 and 255. If a number between 0 and 1 is passed, it's assumed to be a normalized percentage. You may also pass it as a string (e.g. '25%')
  • green - same as above, but for the green channel
  • blue - same as above, but for the blue channel
  • alpha - opacity

Returns: An rgba string accepted by CSS, of the form rgba(red, green, blue, alpha).

License

MIT