Skip to content
dbx tools

Interface: BrandProviderProps

Extends

Section titled “Extends”
  • PropsWithChildren

Properties

Section titled “Properties”

applyToDocument?

Section titled “applyToDocument?”

optional applyToDocument?: boolean

children?

Section titled “children?”

optional children?: ReactNode

Inherited from

Section titled “Inherited from”

PropsWithChildren.children

context?

Section titled “context?”

optional context?: object

assets?

Section titled “assets?”

optional assets?: object

assets.favicon?
Section titled “assets.favicon?”

optional favicon?: string

assets.icon?
Section titled “assets.icon?”

optional icon?: object

assets.icon.dark?
Section titled “assets.icon.dark?”

optional dark?: string

assets.icon.light
Section titled “assets.icon.light”

light: string

Section titled “assets.logo?”

optional logo?: object

assets.logo.dark?
Section titled “assets.logo.dark?”

optional dark?: string

assets.logo.light
Section titled “assets.logo.light”

light: string

colors?

Section titled “colors?”

optional colors?: object = BrandColorsSchema

colors.accent?
Section titled “colors.accent?”

optional accent?: string

colors.background?
Section titled “colors.background?”

optional background?: string

colors.border?
Section titled “colors.border?”

optional border?: string

colors.foreground?
Section titled “colors.foreground?”

optional foreground?: string

colors.muted?
Section titled “colors.muted?”

optional muted?: string

colors.primary?
Section titled “colors.primary?”

optional primary?: string

colors.primaryHover?
Section titled “colors.primaryHover?”

optional primaryHover?: string

colors.surface?
Section titled “colors.surface?”

optional surface?: string

description?

Section titled “description?”

optional description?: string

extensions?

Section titled “extensions?”

optional extensions?: Record<string, unknown>

Section titled “links?”

optional links?: object

links.documentation?
Section titled “links.documentation?”

optional documentation?: string

links.repository?
Section titled “links.repository?”

optional repository?: string

links.website?
Section titled “links.website?”

optional website?: string

name?

Section titled “name?”

optional name?: string

schemaVersion?

Section titled “schemaVersion?”

optional schemaVersion?: "1"

shortName?

Section titled “shortName?”

optional shortName?: string

tagline?

Section titled “tagline?”

optional tagline?: string

typography?

Section titled “typography?”

optional typography?: object

typography.mono?
Section titled “typography.mono?”

optional mono?: string

typography.sans?
Section titled “typography.sans?”

optional sans?: string

voice?

Section titled “voice?”

optional voice?: object = BrandVoiceSchema

voice.audience?
Section titled “voice.audience?”

optional audience?: string[]

voice.avoid?
Section titled “voice.avoid?”

optional avoid?: string[]

voice.principles?
Section titled “voice.principles?”

optional principles?: string[]

voice.tone?
Section titled “voice.tone?”

optional tone?: string[]

resolveAsset?

Section titled “resolveAsset?”

optional resolveAsset?: BrandAssetResolver