Function mostReadable

  • mostReadable(baseColor, colorList, args?): TinyColor | null

  • Given a base color and a list of possible foreground or background colors for that base, returns the most readable color. Optionally returns Black or White if the most readable color is unreadable.

    Parameters

    • baseColor: ColorInput

      the base color.

    • colorList: ColorInput[]

      array of colors to pick the most readable one from.

    • args: WCAG2FallbackParms = ...

      and object with extra arguments

      Example

      new TinyColor().mostReadable('#123', ['#124", "#125'], { includeFallbackColors: false }).toHexString(); // "#112255"
      new TinyColor().mostReadable('#123', ['#124", "#125'],{ includeFallbackColors: true }).toHexString();  // "#ffffff"
      new TinyColor().mostReadable('#a8015a', ["#faf3f3"], { includeFallbackColors:true, level: 'AAA', size: 'large' }).toHexString(); // "#faf3f3"
      new TinyColor().mostReadable('#a8015a', ["#faf3f3"], { includeFallbackColors:true, level: 'AAA', size: 'small' }).toHexString(); // "#ffffff"

    Returns TinyColor | null

Settings

Member Visibility

Theme