Branding
Branding
branding sets the visible agent name and partner colors.
Omit it to keep THEO and the product theme.
Pass theme values on the options object. CSS variable names are not a host contract.
The design system's resolvePartnerTheme resolves branding.theme.
The SDK adds no theme resolution of its own.
Set the partner color as palette.primary or colors.partner.primary.
Either one seeds the partner tokens and, for hex, the brand ramp.
A partner primary never keeps the Augeo ramp or roles.
Prerequisites
| Item | Value |
|---|---|
| Persona | loyalty-concierge |
| Root options | container and auth.getToken already work |
Read Configuration first.
Fields
| Field | Required | Default | Effect |
|---|---|---|---|
agentName | no | THEO | Label shown as the assistant name |
theme.palette.primary | no | product primary | Seeds partner tokens and, for hex, a brand ramp |
theme.palette.onPrimary | no | WCAG pick for hex | Text and icons on primary-filled surfaces |
theme.colors.partner.primary | no | product primary | Seeds the same tokens when palette primary is omitted |
theme.colors.partner | no | derived | Per-token override that beats the derived value |
theme.brandRamp | no | generated from hex primary | Eleven hex rungs that v2 components read |
theme.brandRoles | no | seed-rung roles | Maps roles such as primary onto ramp steps |
Agent name
Before
new AugeoAssistant({
container: '#chat-host',
auth: { getToken: () => token },
});The header displays THEO.
Blank or whitespace names also fall back to THEO.
After
branding: { agentName: 'Ava' }The header displays Ava instead of THEO.
Palette primary
palette.primary is the partner brand color.
Hex values such as #rgb and #rrggbb are parsed case-insensitively.
Before
branding: { agentName: 'Ava' }Partner chips, focus rings, the send button, and the overlay FAB stay product-colored.
After, hex primary
branding: {
agentName: 'Ava',
theme: { palette: { primary: '#6119ea' } },
}Those partner surfaces use #6119ea.
The design system also derives tint, emphasis, on-primary, and a complete brand ramp.
Derived partner tokens
A hex palette.primary writes five colors.partner keys.
| Token | Hex derivation |
|---|---|
primary | palette.primary verbatim |
primary-emphasis | 85% primary / 15% black |
primary-tint-10 | 10% primary / 90% white |
primary-tint-25 | 25% primary / 75% white |
on-primary | palette.onPrimary, else a WCAG contrast pick |
v2 components read brandRamp through brandRoles.
They do not read colors.partner.
Non-hex primary
Non-hex strings such as rebeccapurple or oklch(...) are used verbatim.
Variants become color-mix expressions.
They cannot emit v2 ramp rungs.
Before
theme: { palette: { primary: '#6119ea' } }Hex input yields numeric tints and a generated ramp.
After
theme: {
palette: {
primary: 'rebeccapurple',
onPrimary: '#ffffff',
},
}primary stays rebeccapurple.
Tint and emphasis use color-mix against white and black.
Supply onPrimary here, because contrast derivation needs hex.
Without onPrimary, non-hex falls back to #ffffff.
Brand ramp
Ramp steps are 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, and 950.
A hex primary places the seed on the nearest lightness rung.
Lighter rungs mix toward white.
Darker rungs mix toward black.
An explicit complete ramp wins over the generated ramp. Every step must be a hex string for the ramp to count as complete.
Brand roles
Roles include primary, primary-readable, and primary-shade.
The tints derive from the brand fill, so they take no role.
Generated roles set primary to the seed step.
Explicit brandRoles stay as supplied.
Generated seed roles are skipped when you pass any roles or a complete ramp.
Before, generated roles
theme: { palette: { primary: '#6119ea' } }The design system fills all eleven rungs.
It points primary at the seed step.
After, explicit ramp and roles
theme: {
palette: { primary: '#6119ea' },
brandRamp: {
50: '#f5f0ff',
100: '#ebe0ff',
200: '#d4bfff',
300: '#b894ff',
400: '#8a5cff',
500: '#6119ea',
600: '#5214c7',
700: '#4310a3',
800: '#360d84',
900: '#2c0b6c',
950: '#1c0747',
},
brandRoles: {
primary: 500,
'primary-shade': 700,
},
}Those rungs and roles win. Palette generation does not replace them.
Partner overrides
Explicit colors.partner values beat derived values for the same token.
Other derived tokens still come from the partner primary.
Without a palette, colors.partner.primary seeds the same derivation.
Before
theme: { palette: { primary: '#6119ea' } }colors.partner.primary is #6119ea.
After
theme: {
palette: { primary: '#6119ea' },
colors: {
partner: {
primary: '#111111',
'on-primary': '#ffffff',
},
},
}colors.partner.primary is #111111.
on-primary is #ffffff.
Tint and emphasis still derive from #6119ea unless you override those keys too.
Related pages
| Topic | Page |
|---|---|
| Root options | Configuration |
| Presentation shells | Surfaces |
| Feature groups | Capabilities |
| Minimal embed | Quick start |
| Public types | API |
| Mount failures | Common issues |