Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( ColorPrimary = Token{Name: "--color-primary", Dark: "#1b5d8c"} ColorOnPrimary = Token{Name: "--color-on-primary", Dark: "#FFFFFF"} ColorSuccess = Token{Name: "--color-success", Dark: "#1e7a30"} ColorOnSuccess = Token{Name: "--color-on-success", Dark: "#FFFFFF"} ColorDanger = Token{Name: "--color-danger", Dark: "#ba2c0d"} ColorOnDanger = Token{Name: "--color-on-danger", Dark: "#FFFFFF"} ColorBackground = Token{Name: "--color-background", Light: "#FFFFFF", Dark: "#0D1117"} ColorOnBackground = Token{Name: "--color-on-background", Light: "#1C1C1E", Dark: "#E6EDF3"} ColorSurface = Token{Name: "--color-surface", Light: "#F2F2F7", Dark: "#161B22"} ColorOnSurface = Token{Name: "--color-on-surface", Light: "#1C1C1E", Dark: "#E6EDF3"} ColorOutline = Token{Name: "--color-outline", Light: "#D1D1D6", Dark: "#30363D"} ColorMuted = Token{Name: "--color-muted", Light: "#6E6E73", Dark: "#8B949E"} TextXs = Token{Name: "--text-xs", Dark: "0.75rem"} TextSm = Token{Name: "--text-sm", Dark: "0.875rem"} TextBase = Token{Name: "--text-base", Dark: "1rem"} TextLg = Token{Name: "--text-lg", Dark: "1.25rem"} TextXl = Token{Name: "--text-xl", Dark: "1.5rem"} Text2xl = Token{Name: "--text-2xl", Dark: "2rem"} LeadingNormal = Token{Name: "--leading-normal", Dark: "1.5"} FontWeightRegular = Token{Name: "--font-weight-regular", Dark: "400"} FontWeightMedium = Token{Name: "--font-weight-medium", Dark: "500"} FontWeightBold = Token{Name: "--font-weight-bold", Dark: "700"} Space0 = Token{Name: "--space-0", Dark: "0"} Space1 = Token{Name: "--space-1", Dark: "0.25rem"} Space2 = Token{Name: "--space-2", Dark: "0.5rem"} Space3 = Token{Name: "--space-3", Dark: "0.75rem"} Space4 = Token{Name: "--space-4", Dark: "1rem"} Space6 = Token{Name: "--space-6", Dark: "1.5rem"} Space8 = Token{Name: "--space-8", Dark: "2rem"} Space12 = Token{Name: "--space-12", Dark: "3rem"} RadiusSm = Token{Name: "--radius-sm", Dark: "4px"} RadiusMd = Token{Name: "--radius-md", Dark: "8px"} RadiusLg = Token{Name: "--radius-lg", Dark: "16px"} RadiusFull = Token{Name: "--radius-full", Dark: "9999px"} ShadowSm = Token{Name: "--shadow-sm", Dark: "0 1px 2px rgba(0, 0, 0, 0.05)"} ShadowMd = Token{Name: "--shadow-md", Dark: "0 4px 6px rgba(0, 0, 0, 0.10)"} ShadowLg = Token{Name: "--shadow-lg", Dark: "0 10px 15px rgba(0, 0, 0, 0.10)"} DurationFast = Token{Name: "--duration-fast", Dark: "150ms"} DurationBase = Token{Name: "--duration-base", Dark: "250ms"} DurationSlow = Token{Name: "--duration-slow", Dark: "400ms"} EaseInOut = Token{Name: "--ease-in-out", Dark: "cubic-bezier(0.4, 0, 0.2, 1)"} ZBase = Token{Name: "--z-base", Dark: "0"} ZDropdown = Token{Name: "--z-dropdown", Dark: "100"} ZSticky = Token{Name: "--z-sticky", Dark: "200"} ZModal = Token{Name: "--z-modal", Dark: "300"} ZToast = Token{Name: "--z-toast", Dark: "400"} ZTooltip = Token{Name: "--z-tooltip", Dark: "500"} BpSm = Token{Name: "--bp-sm", Dark: "640px"} BpMd = Token{Name: "--bp-md", Dark: "768px"} BpLg = Token{Name: "--bp-lg", Dark: "1024px"} BpXl = Token{Name: "--bp-xl", Dark: "1280px"} MaxWReadable = Token{Name: "--max-w-readable", Dark: "65ch"} ColumnNarrow = Token{Name: "--column-narrow", Dark: "12rem"} ColumnMedium = Token{Name: "--column-medium", Dark: "20rem"} ColumnWide = Token{Name: "--column-wide", Dark: "30rem"} )
var ( SurfacePrimary = Pair{ColorPrimary, ColorOnPrimary} SurfacePanel = Pair{ColorSurface, ColorOnSurface} SurfaceBackground = Pair{ColorBackground, ColorOnBackground} SurfaceDanger = Pair{ColorDanger, ColorOnDanger} SurfaceSuccess = Pair{ColorSuccess, ColorOnSuccess} )
Functions ¶
Types ¶
type NamedPair ¶ added in v0.3.1
type NamedPair struct {
Name string
Bg ValueGetter
Fg ValueGetter
Min float64
}
NamedPair is a descriptor used for contrast compliance verification.
type Override ¶ added in v0.1.3
type Override struct {
// contains filtered or unexported fields
}
Override is the customized override of a single Token's value.
type Pair ¶ added in v0.2.0
type Pair struct{ Bg, Fg Token }
Pair represents a complete surface decision: background and foreground colors coupled.
type Stylesheet ¶ added in v0.0.2
type Stylesheet struct {
// contains filtered or unexported fields
}
func NewStylesheet ¶ added in v0.1.0
func NewStylesheet(items ...item) *Stylesheet
func RenderCSS ¶ added in v0.0.2
func RenderCSS() *Stylesheet
func RootCSS ¶ added in v0.0.2
func RootCSS() *Stylesheet
func Theme ¶ added in v0.1.3
func Theme(overrides ...Override) *Stylesheet
Theme returns the entire RootCSS() catalog with custom overrides appended.
func (*Stylesheet) String ¶ added in v0.0.2
func (s *Stylesheet) String() string
type Token ¶ added in v0.0.2
type Token struct {
Name string
Light, Dark string // Dark solo = static fallback; ambos = light-dark pair
}
Token is a design token: a named visual decision with a fallback value. For static tokens, Dark holds the literal fallback and Light is empty. For theme tokens, Light and Dark hold the light/dark pair and Var/GetFallback generate light-dark(Light, Dark) automatically.
func (Token) GetFallback ¶ added in v0.3.1
GetFallback returns the default/fallback value of the token.
type ValueGetter ¶ added in v0.3.1
ValueGetter defines the interface for retrieving token metadata.