Variable: parseBrandContext
constparseBrandContext: (input) =>object=sharedBrand.parseBrandContext
Validate input and fill every dbx tools default.
Parameters
Section titled “Parameters”input?
Section titled “input?”unknown = {}
Returns
Section titled “Returns”object
assets
Section titled “assets”assets:
object
assets.favicon
Section titled “assets.favicon”favicon:
string
assets.icon
Section titled “assets.icon”icon:
object
assets.icon.dark?
Section titled “assets.icon.dark?”
optionaldark?:string
assets.icon.light
Section titled “assets.icon.light”light:
string
assets.logo
Section titled “assets.logo”logo:
object
assets.logo.dark?
Section titled “assets.logo.dark?”
optionaldark?:string
assets.logo.light
Section titled “assets.logo.light”light:
string
colors
Section titled “colors”colors:
object=BrandColorsSchema
colors.accent
Section titled “colors.accent”accent:
string
colors.background
Section titled “colors.background”background:
string
colors.border
Section titled “colors.border”border:
string
colors.foreground
Section titled “colors.foreground”foreground:
string
colors.muted
Section titled “colors.muted”muted:
string
colors.primary
Section titled “colors.primary”primary:
string
colors.primaryHover
Section titled “colors.primaryHover”primaryHover:
string
colors.surface
Section titled “colors.surface”surface:
string
description
Section titled “description”description:
string
extensions
Section titled “extensions”extensions:
Record<string,unknown>
links:
object
links.documentation?
Section titled “links.documentation?”
optionaldocumentation?:string
links.repository?
Section titled “links.repository?”
optionalrepository?:string
links.website?
Section titled “links.website?”
optionalwebsite?:string
name:
string
schemaVersion
Section titled “schemaVersion”schemaVersion:
"1"
shortName
Section titled “shortName”shortName:
string
tagline
Section titled “tagline”tagline:
string
typography
Section titled “typography”typography:
object
typography.mono
Section titled “typography.mono”mono:
string
typography.sans
Section titled “typography.sans”sans:
string
voice:
object=BrandVoiceSchema
voice.audience
Section titled “voice.audience”audience:
string[]
voice.avoid
Section titled “voice.avoid”avoid:
string[]
voice.principles
Section titled “voice.principles”principles:
string[]
voice.tone
Section titled “voice.tone”tone:
string[]