Project @beamwind/colors - v2.0.3

Index

Interfaces

Shades

Type aliases

ThemeColors

Functions

Type aliases

ThemeColors

ThemeColors: Record<string, undefined | string>

Functions

Const createOnColor

createOnColor(colors: ThemeColors, key: string, color?: undefined | string): ThemeColors

- Defined in system.ts:19
Parameters
- colors: ThemeColors
- key: string
- color: undefined | string = colors[key]
Returns ThemeColors

Const createShadeVariants

createShadeVariants(colors: ThemeColors, key: string, shades?: Shades, color?: undefined | string): ThemeColors

- Defined in system.ts:31
Parameters
- colors: ThemeColors
- key: string
- shades: Shades = {}
- color: undefined | string = colors[key]
Returns ThemeColors

Const generateColors

generateColors(base: ThemeColors, shades?: Shades): ThemeColors

- Defined in system.ts:64
Parameters
- base: ThemeColors
- Optional shades: Shades
Returns ThemeColors

Const generateOnColors

generateOnColors(base: ThemeColors): ThemeColors

- Defined in system.ts:26
Parameters
- base: ThemeColors
Returns ThemeColors

Const getContrastVariant

getContrastVariant(color: string): string

- Defined in colors.ts:245
Finds the closest accessible color.

Parameters
- color: string
  
  in #-hexadecimal notation (like #RRGGBB or #RGB)
Returns string

contrast color in #-hexadecimal notation

Const getDarkVariant

getDarkVariant(color: string): string

- Defined in colors.ts:159
Parameters
- color: string
Returns string

Const getLightVariant

getLightVariant(color: string): string

- Defined in colors.ts:159
Parameters
- color: string
Returns string

Const getShadeVariant

getShadeVariant(color: string, ifLight: number, ifDark?: number): string

- Defined in colors.ts:274
Creates a shade color using ifLight if color is light otherwise ifDark.

Parameters
- color: string
  
  to shade in #-hexadecimal notation (like #RRGGBB or #RGB)
- ifLight: number
  
  amount between 0 and 1 if color is light
- ifDark: number = ifLight * -1
  
  amount between 0 and 1 if color is dark (eg not light)
Returns string

shaded color in #-hexadecimal notation

Const isLight

isLight(color: string): boolean

- Defined in colors.ts:141
Parameters
- color: string
Returns boolean

Const shade

shade(color: string, amount: number): string

- Defined in colors.ts:254
Changes the lightness of color by the given amount.

Parameters
- color: string
  
  to shade in #-hexadecimal notation (like #RRGGBB or #RGB)
- amount: number
  
  value between 0 and 1
Returns string

shaded color in #-hexadecimal notation

Generated using TypeDoc