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

Contact and social profiles

Provide contact details and official social accounts.

Use brand.contact for official channels your guidelines can display. The object is required, but {} is valid when no contact information is public.

Replace brand.contact in brandtree.config.ts with this partial config example:

contact: {
  email: "brand@example.com",
  website: "https://example.com",
  phone: "+44 20 7946 0000",
  address: ["123 Example Street", "London"],
  socials: [{
    id: "instagram",
    label: "Instagram",
    handle: "@acme",
    url: "https://instagram.com/acme",
  }],
},

Contact fields

PropType
email?string

Public contact email.

Typestring
website?string

Official brand website; distinct from brand.meta.url, the guidelines site origin.

Typestring
phone?string

Reader-facing phone number.

Typestring
address?string[]

Address lines, in display order.

Typestring[]
socials?Social[]

Official accounts. Each needs a unique id plus label, handle, and url.

TypeSocial[]

Use a stable social id even if the account’s displayed label changes. Localization supports translated addresses and social labels; account URLs and handles stay canonical.

Was this page helpful?