Skip to content
dbx tools

Variable: BrandContextSchema

const BrandContextSchema: ZodObject<{ assets: ZodDefault<ZodObject<{ favicon: ZodDefault<ZodString>; icon: ZodDefault<ZodObject<{ dark: ZodOptional<ZodString>; light: ZodString; }, $strict>>; logo: ZodDefault<ZodObject<{ dark: ZodOptional<ZodString>; light: ZodString; }, $strict>>; }, $strict>>; colors: ZodPrefault<ZodObject<{ accent: ZodDefault<ZodString>; background: ZodDefault<ZodString>; border: ZodDefault<ZodString>; foreground: ZodDefault<ZodString>; muted: ZodDefault<ZodString>; primary: ZodDefault<ZodString>; primaryHover: ZodDefault<ZodString>; surface: ZodDefault<ZodString>; }, $strict>>; description: ZodDefault<ZodString>; extensions: ZodDefault<ZodRecord<ZodString, ZodUnknown>>; links: ZodPrefault<ZodObject<{ documentation: ZodOptional<ZodString>; repository: ZodOptional<ZodString>; website: ZodDefault<ZodString>; }, $strict>>; name: ZodDefault<ZodString>; schemaVersion: ZodDefault<ZodLiteral<"1">>; shortName: ZodDefault<ZodString>; tagline: ZodDefault<ZodString>; typography: ZodPrefault<ZodObject<{ mono: ZodDefault<ZodString>; sans: ZodDefault<ZodString>; }, $strict>>; voice: ZodPrefault<ZodObject<{ audience: ZodDefault<ZodArray<ZodString>>; avoid: ZodDefault<ZodArray<ZodString>>; principles: ZodDefault<ZodArray<ZodString>>; tone: ZodDefault<ZodArray<ZodString>>; }, $strict>>; }, $strict> = brandUtils.BrandContextSchema

Zod schema for a complete validated brand context.

BrandContext fields

Section titled “BrandContext fields”

Portable identity, visual, and voice context for UI, libraries, and LLMs.

  • name (optional): Canonical display name.
  • shortName (optional): Compact name for constrained UI.
  • tagline (optional): Short product line suitable for a header or metadata.
  • description (optional): Plain-language product description.
  • assets.icon (optional): Theme-aware references to one visual asset.
  • assets.icon.light: Asset for light surfaces.
  • assets.icon.dark (optional): Asset for dark surfaces; light is the fallback.
  • assets.logo (optional): Theme-aware references to one visual asset.
  • assets.logo.light: Asset for light surfaces.
  • assets.logo.dark (optional): Asset for dark surfaces; light is the fallback.
  • colors.primary (optional): Primary action and identity color.
  • colors.primaryHover (optional): Primary hover or pressed color.
  • colors.accent (optional): Secondary accent color.
  • colors.foreground (optional): Default text and mark color.
  • colors.background (optional): Default page background.
  • colors.surface (optional): Secondary surface background.
  • colors.muted (optional): Muted text color.
  • colors.border (optional): Default border color.
  • extensions (optional): Namespaced consumer-specific values that do not belong in the portable core.