@skchr/color
    Preparing search index...

    Function luminance

    • Sets/Gets the luminance of the passed in color token.

      If the amount argument is passed in, it will adjust the luminance by interpolating the color with black (to decrease luminance) or white (to increase the luminance) by the specified amount.

      If the amount argument is not passed in however, it will simply return the color token's luminance.

      Type Parameters

      • Amount

      Parameters

      • Optionalcolor: ColorToken

        The color to retrieve or adjust luminance.

      • Optionalamount: number = undefined

        The amount of luminance to set. The value range is normalised between [0,1].

      Returns Amount extends number ? ColorToken : number

      • The luminance value if amount is omitted, or the color token with the new luminance if amount is provided.
      import { luminance } from '@skchr/color'

      // Getting the luminance

      console.log(luminance('#a1bd2f'))
      // 0.4417749513730954

      console.log(colors('all', '400').map((c) => luminance(c)));

      // [
        0.3595097699638928,  0.3635745068550118,
        0.3596908494424909,  0.3662525955988395,
       0.36634113914916244, 0.32958967582076004,
       0.41393242740130043,  0.5789820793721787,
        0.6356386777636567,  0.6463720036841869,
        0.5525691083297639,  0.4961850321908156,
        0.5140644334784611,  0.4401325598899415,
       0.36299191043315415,  0.3358285501372504,
       0.34737270839643575, 0.37670102542883394,
        0.3464512307705231, 0.34012939384198054
      ]

      // setting the luminance

      let myColor = luminance('#a1bd2f', 0.5)

      console.log(luminance(myColor))
      // 0.4999999136285792

    Settings

    Member Visibility