Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

Logo Colorways

Display approved logo and background combinations from your brand configuration.

<LogoColorways cols={2} />

Usage

Display every approved colorway for the configured logotype. Define the foreground, background, and optional label of each combination in Logos.

<LogoColorways />

Examples

Use two columns for the logotype

The opening preview sets cols={2} to show approved logotype pairs in a compact grid. Compare it with the default three-column brandmark example below.

<LogoColorways cols={2} />

Show brandmark colorways

Set mark="brandmark" to apply the same approved combinations to the standalone mark.

<LogoColorways mark="brandmark" />

Publish approved combinations

Replace brand.logo.colorways in brandtree.config.ts to change the rendered pairs. This fragment uses the universal black and white references. Add palette tokens from your own configuration for other approved combinations. An omitted label leaves just the generated foreground/background caption.

colorways: [
  { id: "primary", fg: "black", bg: "white", label: "Light" },
  { id: "reversed", fg: "white", bg: "black" },
],

Layout and selection

Every entry in brand.logo.colorways is rendered in configuration order; there is no only filter. cols controls the layout from 48rem up. Below that viewport width, the grid always uses two columns, including when cols={1}.

API reference

PropType
brand?BrandConfig

Override the resolved brand for this component. Supplied automatically in Brandtree MDX.

TypeBrandConfig
Defaultprops.brand
mark?"logotype" | "brandmark"
Type"logotype" | "brandmark"
Default"logotype"
cols?number

Columns from the medium breakpoint up.

Typenumber
Default3
class?string

Additional class on the outer element.

Typestring

Was this page helpful?