# All files / color grayscale.js

100% Statements 1/1
100% Branches 0/0
100% Functions 1/1
100% Lines 1/1

    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

    3x

     // @flow

    import parseToHsl from './parseToHsl'
    import toColorString from './toColorString'

    /**
     * Converts the color to a grayscale, by reducing its saturation to 0.
     *
     * @example
     * // Styles as object usage
     * const styles = {
     *   background: grayscale('#CCCD64'),
     *   background: grayscale('rgba(204,205,100,0.7)'),
     * }
     *
     * // styled-components usage
     * const div = styled.div`
     *   background: ${grayscale('#CCCD64')};
     *   background: ${grayscale('rgba(204,205,100,0.7)')};
     * `
     *
     * // CSS in JS Output
     * element {
     *   background: "#999";
     *   background: "rgba(153,153,153,0.7)";
     * }
     */
    function grayscale(color: string): string {
      return toColorString({
        ...parseToHsl(color),
        saturation: 0,
      })
    }

    export default grayscale