# All files / color hsl.js

100% Statements 5/5
100% Branches 10/10
100% Functions 1/1
100% Lines 5/5

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40

    23x
    2x
    21x
    20x

    1x

     // @flow

    import hslToHex from '../internalHelpers/_hslToHex'
    import type { HslColor } from '../types/color'

    /**
     * Returns a string value for the color. The returned result is the smallest possible hex notation.
     *
     * @example
     * // Styles as object usage
     * const styles = {
     *   background: hsl(359, 0.75, 0.4),
     *   background: hsl({ hue: 360, saturation: 0.75, lightness: 0.4 }),
     * }
     *
     * // styled-components usage
     * const div = styled.div`
     *   background: ${hsl(359, 0.75, 0.4)};
     *   background: ${hsl({ hue: 360, saturation: 0.75, lightness: 0.4 })};
     * `
     *
     * // CSS in JS Output
     *
     * element {
     *   background: "#b3191c";
     *   background: "#b3191c";
     * }
     */
    function hsl(value: HslColor | number, saturation?: number, lightness?: number): string {
      if (typeof value === 'number' && typeof saturation === 'number' && typeof lightness === 'number') {
        return hslToHex(value, saturation, lightness)
      } else if (typeof value === 'object' && saturation === undefined && lightness === undefined) {
        return hslToHex(value.hue, value.saturation, value.lightness)
      }

      throw new Error('Passed invalid arguments to hsl, please pass multiple numbers e.g. hsl(360, 0.75, 0.4) or an object e.g. rgb({ hue: 255, saturation: 0.4, lightness: 0.75 }).')
    }

    export default hsl