theming

Documentation

Index

• Variables
• func WithColorScheme(colorScheme ColorScheme) func(opt *theming)
• func WithTypography(typography Typography) func(opt *theming)
• type ColorScheme
  • func ColorSchemeFrom(primaryKeyColor color.Color, optionFns ...ColorSchemeOptionFunc) ColorScheme
• type ColorSchemeOptionFunc
  • func AsDarkMode() ColorSchemeOptionFunc
  • func WithCustomKeyColor(role colorrole.ColorRole, keyColor color.Color) ColorSchemeOptionFunc
  • func WithNeutralKeyColor(keyColor color.Color) ColorSchemeOptionFunc
  • func WithNeutralVariantKeyColor(keyColor color.Color) ColorSchemeOptionFunc
  • func WithSecondaryKeyColor(keyColor color.Color) ColorSchemeOptionFunc
  • func WithTertiaryKeyColor(keyColor color.Color) ColorSchemeOptionFunc
• type FontProvider
• type Fonts
• type OptionFunc
• type Theming
  • func New(optFns ...OptionFunc) Theming
• type TonalPalette
  • func TonalPaletteFromHueAndChroma(hue, chroma float32) TonalPalette
• type TypeScales
  • func CreateDefaultTypeScales(fp FontProvider) TypeScales
• type Typography
  • func NewTypography(opts ...TypographyOptionFunc) Typography
• type TypographyOptionFunc
  • func WithFonts(fonts Fonts) TypographyOptionFunc
  • func WithTypeScales(create func(fp FontProvider) TypeScales) TypographyOptionFunc

Variables

var Context = contextutil.New[Theming]()

var DefaultColorScheme = ColorSchemeFrom(f32color.RGB(0x6750A4))

var DefaultTypography = NewTypography()

Functions

func WithColorScheme

func WithColorScheme(colorScheme ColorScheme) func(opt *theming)

func WithTypography

func WithTypography(typography Typography) func(opt *theming)

Types

type ColorScheme

type ColorScheme interface {
	Color(role colorrole.ColorRole) color.NRGBA
}

func ColorSchemeFrom

func ColorSchemeFrom(primaryKeyColor color.Color, optionFns ...ColorSchemeOptionFunc) ColorScheme

type ColorSchemeOptionFunc

type ColorSchemeOptionFunc func(p *palette)

func AsDarkMode

func AsDarkMode() ColorSchemeOptionFunc

func WithCustomKeyColor

func WithCustomKeyColor(role colorrole.ColorRole, keyColor color.Color) ColorSchemeOptionFunc

func WithNeutralKeyColor

func WithNeutralKeyColor(keyColor color.Color) ColorSchemeOptionFunc

func WithNeutralVariantKeyColor

func WithNeutralVariantKeyColor(keyColor color.Color) ColorSchemeOptionFunc

func WithSecondaryKeyColor

func WithSecondaryKeyColor(keyColor color.Color) ColorSchemeOptionFunc

func WithTertiaryKeyColor

func WithTertiaryKeyColor(keyColor color.Color) ColorSchemeOptionFunc

type FontProvider

type FontProvider interface {
	Font(font font.Font) string
}

type Fonts

type Fonts map[font.Font][]string

type OptionFunc

type OptionFunc = func(opt *theming)

type Theming

type Theming interface {
	Typography
	ColorScheme
}

func New

func New(optFns ...OptionFunc) Theming

type TonalPalette

type TonalPalette interface {
	Toned(tone float32) color.Color
}

func TonalPaletteFromHueAndChroma

func TonalPaletteFromHueAndChroma(hue, chroma float32) TonalPalette

type TypeScales

type TypeScales map[typescale.TypeScale]text.Style

func CreateDefaultTypeScales

func CreateDefaultTypeScales(fp FontProvider) TypeScales

type Typography

type Typography interface {
	FontProvider
	TypeScale(typeScale typescale.TypeScale) text.Style
}

func NewTypography

func NewTypography(opts ...TypographyOptionFunc) Typography

type TypographyOptionFunc

type TypographyOptionFunc func(t *typography)

func WithFonts

func WithFonts(fonts Fonts) TypographyOptionFunc

func WithTypeScales

func WithTypeScales(create func(fp FontProvider) TypeScales) TypographyOptionFunc