@fungi.computer/stipe
Type Aliases
Section titled “Type Aliases”EmbedThemeOptions
Section titled “EmbedThemeOptions”EmbedThemeOptions =
Readonly<{accent?:string;fontFamily?:string; }>
Host inputs for the embed and embed-dark themes. Both are optional.
EmbedThemeProperties
Section titled “EmbedThemeProperties”EmbedThemeProperties =
Readonly<Record<string,string>>>>
Custom properties the embed themes read, keyed by property name.
TerminalPalette
Section titled “TerminalPalette”TerminalPalette =
object
Semantic terminal colors projected from a maintained theme.
Properties
Section titled “Properties”background
Section titled “background”
readonlybackground:string
foreground
Section titled “foreground”
readonlyforeground:string
cursor
Section titled “cursor”
readonlycursor:string
cursorAccent
Section titled “cursorAccent”
readonlycursorAccent:string
selectionBackground
Section titled “selectionBackground”
readonlyselectionBackground:string
primary
Section titled “primary”
readonlyprimary:string
accent
Section titled “accent”
readonlyaccent:string
success
Section titled “success”
readonlysuccess:string
readonlyinfo:string
warning
Section titled “warning”
readonlywarning:string
readonlyerror:string
readonlyblack:string
readonlyred:string
readonlygreen:string
yellow
Section titled “yellow”
readonlyyellow:string
readonlyblue:string
magenta
Section titled “magenta”
readonlymagenta:string
readonlycyan:string
readonlywhite:string
brightBlack
Section titled “brightBlack”
readonlybrightBlack:string
brightRed
Section titled “brightRed”
readonlybrightRed:string
brightGreen
Section titled “brightGreen”
readonlybrightGreen:string
brightYellow
Section titled “brightYellow”
readonlybrightYellow:string
brightBlue
Section titled “brightBlue”
readonlybrightBlue:string
brightMagenta
Section titled “brightMagenta”
readonlybrightMagenta:string
brightCyan
Section titled “brightCyan”
readonlybrightCyan:string
brightWhite
Section titled “brightWhite”
readonlybrightWhite:string
selectionForeground?
Section titled “selectionForeground?”
readonlyoptionalselectionForeground?:string
Variables
Section titled “Variables”EMBED_THEME_TOKENS
Section titled “EMBED_THEME_TOKENS”
constEMBED_THEME_TOKENS:object
The embed themes’ default chrome tokens, for surfaces outside Daisy (the
loader’s launcher in a host page’s shadow root). styles.css defines the same
values; a test keeps the two in step.
Type Declaration
Section titled “Type Declaration”
readonlyembed:object
embed.base100
Section titled “embed.base100”
readonlybase100:"#ffffff"="#ffffff"
embed.baseContent
Section titled “embed.baseContent”
readonlybaseContent:"#1f2328"="#1f2328"
embed.primary
Section titled “embed.primary”
readonlyprimary:"#2f5fd0"="#2f5fd0"
embed.primaryContent
Section titled “embed.primaryContent”
readonlyprimaryContent:"#ffffff"="#ffffff"
embed-dark
Section titled “embed-dark”
readonlyembed-dark:object
embed-dark.base100
Section titled “embed-dark.base100”
readonlybase100:"#1b1d21"="#1b1d21"
embed-dark.baseContent
Section titled “embed-dark.baseContent”
readonlybaseContent:"#e8eaed"="#e8eaed"
embed-dark.primary
Section titled “embed-dark.primary”
readonlyprimary:"#7aa2f7"="#7aa2f7"
embed-dark.primaryContent
Section titled “embed-dark.primaryContent”
readonlyprimaryContent:"#000000"="#000000"
STIPE_GOOEY_FILTER
Section titled “STIPE_GOOEY_FILTER”
constSTIPE_GOOEY_FILTER:Readonly<{alphaIntercept:-9;alphaSlope:19;blurStdDeviation:1.5; }>
Frozen Gooey SVG filter constants for Stipe’s visual law.
STIPE_SPACING_NAMES
Section titled “STIPE_SPACING_NAMES”
constSTIPE_SPACING_NAMES: readonly ["2xs","xs","sm","md","lg","xl","2xl","3xl","4xl"]
Named spacing scale shared by CSS utilities and class conflict resolution.
STIPE_TOKEN_NAMES
Section titled “STIPE_TOKEN_NAMES”
constSTIPE_TOKEN_NAMES: readonly ["--stipe-font-synthesis","--stipe-surface-frame-width","--stipe-surface-frame-image","--stipe-surface-molding-contrast","--stipe-shadow-raised","--stipe-shadow-inset","--stipe-shadow-edge","--stipe-display-texture-image","--stipe-display-text-shadow","--stipe-canvas","--stipe-surface","--stipe-surface-raised","--stipe-surface-selected","--stipe-fg-muted","--stipe-linework","--stipe-hairline","--stipe-figure-ink","--stipe-density-compact","--stipe-density-comfortable","--stipe-motion-spring","--stipe-motion-squish","--stipe-motion-fast","--stipe-motion-normal","--stipe-motion-slow","--stipe-motion-ease","--stipe-layer-base","--stipe-layer-popover","--stipe-layer-modal","--stipe-layer-toast","--stipe-icon-size-sm","--stipe-icon-size-md","--stipe-icon-size-lg","--stipe-icon-stroke","--stipe-card-rim","--stipe-card-rim-edge","--stipe-card-face","--stipe-card-panel","--stipe-card-ink","--stipe-card-ink-muted","--stipe-card-accent","--stipe-art-coral","--stipe-art-blue","--stipe-art-mint","--stipe-art-grape","--stipe-art-yellow","--stipe-art-cream","--stipe-art-ink","--stipe-art-inkcap","--stipe-art-graphite","--stipe-sketch-ink"]
Canonical Stipe token names in declaration order.
Functions
Section titled “Functions”readableContentColor()
Section titled “readableContentColor()”readableContentColor(
hex):"#ffffff"|"#000000"
Black or white, whichever has the higher WCAG contrast on hex.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”"#ffffff" | "#000000"
embedThemeProperties()
Section titled “embedThemeProperties()”embedThemeProperties(
options):EmbedThemeProperties
Project host inputs onto the embed themes’ custom properties. The host applies
them (for example with style.setProperty) beside data-theme="embed" or
data-theme="embed-dark".
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”terminalPalette()
Section titled “terminalPalette()”terminalPalette(
theme):TerminalPalette|undefined
Return the maintained terminal palette for an exact theme name.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”TerminalPalette | undefined
References
Section titled “References”pierreTreesStyle
Section titled “pierreTreesStyle”Re-exports pierreTreesStyle
PierreTreesStyleOptions
Section titled “PierreTreesStyleOptions”Re-exports PierreTreesStyleOptions
applyTheme
Section titled “applyTheme”Re-exports applyTheme
getTheme
Section titled “getTheme”Re-exports getTheme
subscribeTheme
Section titled “subscribeTheme”Re-exports subscribeTheme
ThemeListener
Section titled “ThemeListener”Re-exports ThemeListener