Skip to Content
BBRICKSv0.7.4
PR PortalBrands

BrandDetailHeader

The PR brand page's top (the mock's crumb + .bav.lg title + tools): a breadcrumb back to Brands, the brand's square and name as the page's h1, its program and wallet pills and a muted meta line, then the quick actions. The actions wrap under the title on a narrow screen.

import { BrandDetailHeader } from '@ergasti/bricks';

Examples

Brand page header

Name, program status, wallet health (with the day when it is below zero), meta lines, back and actions. Under it, the "view as brand" banner.

Code
import { Button, BrandDetailHeader, ViewAsBanner } from '@ergasti/bricks';

function Header() {
  return (
    <div style={{ display: 'grid', gap: 12 }}>
      <BrandDetailHeader name="Kemet Home" color="#3D5A10" status="active" health="negative" healthDay={4} meta={['Since 5 Oct 2026', '12% of sale']} onBack={() => {}} actions={<><Button>View as brand</Button><Button variant="ink">New challenge</Button></>} />
      <ViewAsBanner brandName="Kemet Home" onExit={() => {}} />
    </div>
  );
}

Brand wallet

Available, held and balance, the wallet's health, and the TRNDR fee (default or the brand's own) with adjust and change actions.

Code
import { BrandWalletCard } from '@ergasti/bricks';

function Wallet() {
  return (
    <div style={{ display: 'grid', gap: 16, gridTemplateColumns: 'repeat(auto-fit, minmax(320px, 1fr))' }}>
      <BrandWalletCard available="-8400.00" held="1200.00" balance="-7200.00" leftPercent={0} health="negative" healthDay={4} feePercent="5" feeIsDefault onAdjust={() => {}} onChangeFee={() => {}} />
      <BrandWalletCard available="43390.00" held="18450.00" balance="61840.00" leftPercent={62} health="ok" feePercent="4" feeIsDefault={false} onAdjust={() => {}} onChangeFee={() => {}} />
    </div>
  );
}

Back to your own list

backLabel names the crumb when the list it goes back to is not "Brands" (here a PR's own brands); a paused program with a low wallet.

Code
import { BrandDetailHeader } from '@ergasti/bricks';

function BackLabel() {
  return <BrandDetailHeader name="Mira Beauty" color="#5B3BB0" status="paused" health="low" meta={['Since 2 Sep 2026', '8% of sale', 'PR owner: Mona']} onBack={() => {}} backLabel="My brands" />;
}

How brands top up

The note under the buttons says how a brand can add money: the default topUpMethods="card-or-bank" reads "Brands top up by card (Paymob) or bank transfer."; "card" reads "Brands top up by card (Paymob)." for a market where bank transfers are off (the PR mock's brand page). Default on the left.

Code
import { BrandWalletCard } from '@ergasti/bricks';

function TopUpMethods() {
  return (
    <div style={{ display: 'grid', gap: 16, gridTemplateColumns: 'repeat(auto-fit, minmax(320px, 1fr))' }}>
      <BrandWalletCard available="43390.00" held="18450.00" balance="61840.00" leftPercent={62} health="ok" feePercent="5" feeIsDefault onAdjust={() => {}} onChangeFee={() => {}} />
      <BrandWalletCard available="43390.00" held="18450.00" balance="61840.00" leftPercent={62} health="ok" feePercent="5" feeIsDefault onAdjust={() => {}} onChangeFee={() => {}} topUpMethods="card" />
    </div>
  );
}

Wallet in Arabic, card top-ups only

The figures read through Money, the note "البراندات بتشحن بالكارت (Paymob)."

Pinned to Arabic
Code
import { BrandWalletCard } from '@ergasti/bricks';

function TopUpCardArabic() {
  return <BrandWalletCard available="12500.00" held="3200.00" balance="15700.00" leftPercent={18} health="low" feePercent="4" feeIsDefault={false} onAdjust={() => {}} onChangeFee={() => {}} topUpMethods="card" />;
}

Props

Prop

Type

Labels

Every word this component draws, in both languages. Override one per component and language with BricksProvider labels under the key prBrandDetail, or with the component's own prop where it has one. A {name} is a value the component fills in.

prBrandDetail
KeyEnglishArabic
crumbsBreadcrumbمسار الصفحة
brandsBrandsالبراندات
ownerPR ownerمسؤول الـ PR
you(you)(إنت)
sinceSince {d}من {d}
walletWalletالمحفظة
availableAvailableالمتاح
heldHeld for ordersمحجوز للطلبات
balanceBalanceالرصيد
leftLeft of last top-upالباقي من آخر شحنة
feeTRNDR feeرسوم TRNDR
feeDefault(default)(الافتراضي)
feeBrand(this brand)(للبراند ده)
adjustAdjust walletعدّل المحفظة
changeFeeChange feeغيّر الرسوم
topupsBrands top up by card (Paymob) or bank transfer.البراندات بتشحن بالكارت (Paymob) أو بتحويل بنكي.
topupsCardBrands top up by card (Paymob).البراندات بتشحن بالكارت (Paymob).
leftPct{p}% left of the last top-upفاضل {p}% من آخر شحنة
viewing[object Object][object Object]
exitExit viewاخرج من العرض

Design guidance

How the BRICKS design system uses BrandDetailHeader. Written in docs/content/components/BrandDetailHeader.md; the props above are read from the code, which wins where the two disagree.

The top of a PR brand page: a breadcrumb back to Brands, the brand's big square and name as the page's h1, its program and wallet pills with a muted meta line, then quick actions; use it once at the top of the brand detail page.

It is the PR mock's brand page head (crumb + .bav.lg title + tools). The actions (View as brand, Pause, New challenge) wrap under the title on narrow screens.

Anatomy

  1. Header (<header class="kit-pr-bhead">): flex, wraps, space-between, 24px below.
  2. Breadcrumb (<nav aria-label="Breadcrumb">, 13px --ink-3): "Brands" (a link button with onBack) / the brand (aria-current="page").
  3. Title (<h1>, display face 28px 800): BrandAvatar lg (52px) and the name.
  4. Meta row: PrStatusPill (Active / Paused), WalletHealthPill ("Below zero · day 4/7"), then muted items separated by "·" ("Since 5 Oct 2026 · 12% of sale").
  5. Actions (.kit-pr-bhead-acts, gap 10).

Variants

PropsLook
status="active" / "paused"Green Active / Paused pill.
health 'ok' | 'low' | 'negative' | 'paused' (+ healthDay)Healthy / Low funds / "Below zero · day 4/7" / Paused.
no onBackThe crumb is plain text (story NoBack).
backLabelAnother crumb word.

States

StateStory
Below zeroBelowZero (Kemet Home, day 4).
HealthyHealthy (Glow Lab).
PausedPaused.
Long nameWraps anywhere.

Usage

import { BrandDetailHeader, BrandWalletCard, Button } from '@ergasti/bricks';

export function BrandPageTop({ back, viewAs, newChallenge, adjust }: { back: () => void; viewAs: () => void; newChallenge: () => void; adjust: () => void }) {
  return (
    <>
      <BrandDetailHeader
        name="Kemet Home"
        color="#6D4C41"
        status="active"
        health="negative"
        healthDay={4}
        meta={['Since 5 Oct 2026', '12% of sale']}
        onBack={back}
        actions={<>
          <Button onClick={viewAs}>View as brand</Button>
          <Button variant="ink" onClick={newChallenge}>New challenge</Button>
        </>}
      />
      <BrandWalletCard available="-8400.00" held="1200.00" balance="-7200.00" leftPercent={0}
        health="negative" healthDay={4} feePercent="5" feeIsDefault onAdjust={adjust} />
    </>
  );
}

Where it appears

  • PR Portal › Brands › Brand detail, top. Screen: PR · Brand.

Guidelines

Do

  • Use it instead of AppHeader's title on the brand page, so the brand is the h1.
  • Keep two or three actions; the primary one last.

Don't

RTL and Arabic

  • Crumb, title and actions mirror; Latin brand names keep their direction; "البراندات", "من 5 أكتوبر 2026".

Tokens

--ink-3, --font-family-display; BrandAvatar, PrStatusPill, WalletHealthPill tokens.

Accessibility

  • <header> with a breadcrumb <nav> (current page marked) and the page <h1>; the square is decorative.
  • Pills say state in words.

Found in the source

  • Roles in the markup: status.
  • ARIA attributes set: aria-label, aria-hidden, aria-current.

Read from the component's source and tests. See Accessibility for the patterns the library follows.

See also: Button · Money · MoneyNote · BrandAvatar · PrIcon · PrStatusPill · WalletHealthPill · useLanguage · AdjustWalletDialog · BrandCell · BrandFeeDialog

Source

src/pr/BrandDetail.tsx (line 61) on GitHub.

On this page