# Brand lockup (Notchset): prompt.md (v2.0.0)

- id: `brand-lockup` · version 2.0.0 · component · free
- category: Data
- build: one set of files for every shadcn style
- install: `npx shadcn@latest add https://notchset.dev/r/brand-lockup.json`
- npm dependencies: none
- registry dependencies: utils, https://notchset.dev/r/notchset-foundation.json
- docs: https://notchset.dev/components/brand-lockup
- The install command carries everything this item needs (files, CSS, tokens, npm and registry dependencies). Prefer it to copying source by hand.

The product's own brand, drawn one way in every template: the plus in the Signature, then the lowercase wordmark in ink, in three sizes. A buyer swaps their name and mark in one place. Customer companies are a different thing (company mark)..

## Build it
- Stack: React 18.3 or 19, TypeScript, Tailwind CSS v4 utility classes on the foundation's roles, a components.json (imports use its aliases).
- Packages: none beyond React.
- Files: `components/ui/notchset/brand-lockup.tsx`.
- Registry dependencies, installed with it automatically: shadcn `utils` (cn), `notchset-foundation`.
- Builds: one set of files, the same for every shadcn style.
- Exports to keep: `BrandLockup`, `BrandMark`, and every exported type.
- CSS: the install adds the notchset foundation (its roles, keyframes and motion switch, reading your shadcn tokens for colour) to your global stylesheet once. Nothing to import by hand.
- Re-running `add` (or `--overwrite`) re-applies those rules: put overrides in your own CSS, never in the installed rules.
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- This item reads `--ns-font-display`, `--ns-ink`, `--ns-signal`.
- Retune it (on any ancestor) with the foundation's roles and hooks: `--ns-bad`, `--ns-bad-ink`, `--ns-band`, `--ns-band-edge`, `--ns-band-grade`, `--ns-band-optimal`, `--ns-beat`, `--ns-bezel`, `--ns-canvas`, `--ns-cat-1`, `--ns-cat-2`, `--ns-cat-3`, `--ns-cat-4`, `--ns-cat-5`, `--ns-cat-6`, `--ns-check`, `--ns-chip`, `--ns-control`, `--ns-control-pad`, `--ns-control-sm`, `--ns-deep`, `--ns-deep-ink`, `--ns-deep-ink-2`, `--ns-deep-line`, `--ns-dialog`, `--ns-dialog-lg`, `--ns-dialog-sm`, `--ns-ease`, `--ns-ease-in`, `--ns-ease-panel`, `--ns-ease-pop`, `--ns-field`, `--ns-flood-arc`, `--ns-flood-aurora`, `--ns-flood-behind-1`, `--ns-flood-behind-2`, `--ns-flood-bloom`, `--ns-flood-deep`, `--ns-flood-dial-bloom`, `--ns-flood-glass`, `--ns-flood-grain`, `--ns-flood-image`, `--ns-flood-ink`, `--ns-flood-ink-low`, `--ns-flood-light`, `--ns-flood-mid`, `--ns-flood-pale`, `--ns-flood-pane`, `--ns-flood-pane-edge`, `--ns-flood-pill-ink`, `--ns-flood-ribbon`, `--ns-flood-ribbon-core`, `--ns-flood-shadow`, `--ns-flood-sheen`, `--ns-flood-wash`, `--ns-font-body`, `--ns-font-display`, `--ns-font-mono`, `--ns-font-script`, `--ns-glass`, `--ns-glass-blur`, `--ns-glass-shadow`, `--ns-glow`, `--ns-grain`, `--ns-gutter`, `--ns-header`, `--ns-heat`, `--ns-hover`, `--ns-ink`, `--ns-ink-2`, `--ns-ink-3`, `--ns-ink-4`, `--ns-leading`, `--ns-lift`, `--ns-light-1`, `--ns-light-2`, `--ns-light-3`, `--ns-light-spread`, `--ns-light-strength`, `--ns-line`, `--ns-line-soft`, `--ns-lit-edge`, `--ns-menu-dy`, `--ns-menu-row`, `--ns-mesh`, `--ns-mesh-frost`, `--ns-ok`, `--ns-ok-ink`, `--ns-orb-body`, `--ns-orb-cool`, `--ns-orb-core`, `--ns-orb-dawn`, `--ns-orb-deep`, `--ns-orb-edge`, `--ns-orb-grain`, `--ns-orb-ground`, `--ns-orb-halo`, `--ns-orb-inner`, `--ns-orb-key`, `--ns-orb-lift`, `--ns-orb-limb`, `--ns-orb-limb-from`, `--ns-orb-rim`, `--ns-orb-skin-hi`, `--ns-orb-skin-lo`, `--ns-orb-skin-mid`, `--ns-orb-warm`, `--ns-panel`, `--ns-panel-w`, `--ns-prism-edge`, `--ns-prism-glint`, `--ns-prism-sheen`, `--ns-prism-tint`, `--ns-pulse`, `--ns-radius`, `--ns-radius-card`, `--ns-radius-full`, `--ns-radius-lg`, `--ns-radius-sm`, `--ns-radius-xl`, `--ns-raised`, `--ns-range`, `--ns-row`, `--ns-row-compact`, `--ns-segment`, `--ns-selected`, `--ns-series`, `--ns-series-core`, `--ns-series-lilac`, `--ns-series-tint`, `--ns-shadow-dialog`, `--ns-shadow-float`, `--ns-shadow-panel`, `--ns-sheet`, `--ns-sheet-bottom`, `--ns-side`, `--ns-signal`, `--ns-sleep-awake`, `--ns-sleep-deep`, `--ns-sleep-light`, `--ns-sleep-rem`, `--ns-space-1`, `--ns-space-2`, `--ns-space-3`, `--ns-space-4`, `--ns-space-5`, `--ns-space-6`, `--ns-space-8`, `--ns-space-section`, `--ns-stack-on`, `--ns-standing-critical`, `--ns-standing-in`, `--ns-standing-out`, `--ns-state-doing`, `--ns-state-done`, `--ns-state-review`, `--ns-state-todo`, `--ns-switch-h`, `--ns-switch-w`, `--ns-text-body`, `--ns-text-control`, `--ns-text-display`, `--ns-text-figure`, `--ns-text-headline`, `--ns-text-hero`, `--ns-text-lede`, `--ns-text-meta`, `--ns-text-page`, `--ns-text-record`, `--ns-text-small`, `--ns-text-strong`, `--ns-text-sub`, `--ns-text-title`, `--ns-tile-shadow`, `--ns-time-born`, `--ns-time-color`, `--ns-time-dialog`, `--ns-time-menu`, `--ns-time-page`, `--ns-time-panel`, `--ns-time-toast`, `--ns-tint`, `--ns-tint-ink`, `--ns-toast-bottom`, `--ns-toast-left`, `--ns-touch`, `--ns-tracking-display`, `--ns-tracking-headline`, `--ns-warn`, `--ns-warn-ink`, `--ns-wash-clay`, `--ns-wash-dusk`, `--ns-wash-graphite`, `--ns-wash-ink`, `--ns-wash-sage`, `--ns-wash-sand`, `--ns-weight-light`, `--ns-weight-medium`, `--ns-weight-regular`, `--ns-weight-strong`, `--ns-well`.
- Never add Tailwind colour classes inside the component.

```tsx
import { BrandLockup, BrandMark } from "@/components/ui/notchset/brand-lockup";
```

## Parts
- A single export that takes props.

## Match the original
- Read `components/ui/notchset/brand-lockup.tsx` as the reference implementation before changing or recreating anything, and match it: sizes, colours per theme, motion timings, copy and behaviour.
- If you deviate (a prop you can't honour, a style you changed, a dependency you swapped), say so in your reply, part by part.
- Keep the accessibility contract, the keyboard map and the motion levels listed below.

## Use it when

### Not when

## Mistakes
- Recreating the component instead of installing it

## Usage

```tsx
"use client";
import { BrandLockup, BrandMark } from "@/components/ui/notchset/brand-lockup";

export default function BrandLockupDemo() {
  return (
    <div className="flex flex-wrap items-center gap-x-8 gap-y-4">
      <BrandLockup size="sm" />
      <BrandLockup size="md" />
      <BrandLockup size="lg" />
      <BrandLockup size="md" name="Fenmoor" />
      <span className="text-[var(--ns-ink)]">
        <BrandMark size={20} />
      </span>
    </div>
  );
}
```

## Props

| Prop | Type | Default | What it does |
|---|---|---|---|
| `size` | `BrandSize` | `"md"` |  |
| `name` | `string` | `"Notchset"` | The wordmark. Defaults to "Notchset"; it is always drawn lowercase. |
| `mark` | `React.ReactNode` |  | A different mark in place of the plus (sized to the lockup, coloured by the Signature). |

Full docs: https://notchset.dev/components/brand-lockup

## Customising
- Colours: every part reads the foundation's roles (`--ns-canvas`, `--ns-ink`, `--ns-line`, `--ns-signal` …), which read your shadcn tokens (`--background`, `--foreground`, `--border`, `--destructive` …), plus the optional `--success` and `--warning`. Retheme on `:root` or any container; never add Tailwind colour classes inside the component.
- Dark mode follows the `.dark` class or `data-theme="dark"` on an ancestor (the shadcn and next-themes conventions).
- Update later: Commit or stash local changes first (or copy the files), so the update can be undone. Read https://notchset.dev/r/changelog.json for the new versions: a major version, an entry marked breaking or a merge says what to change. Then re-run the install with `--overwrite`, on a branch. It replaces the component's files, the shared helper files they import, and the item's CSS rules in the global stylesheet, so review the whole diff (components, shared files, CSS), re-apply your own edits, and run the app's typecheck, tests and build.

## Accessibility contract (preserve when editing)

## Install

```bash
npx shadcn@latest add https://notchset.dev/r/brand-lockup.json
```

Or add the `@notchset` registry to components.json and run `npx shadcn@latest add @notchset/brand-lockup`. Every components.json style gets the same files.

## Continue the workflow

- [Avatar stack](https://notchset.dev/components/avatar-stack)
- [Avatar](https://notchset.dev/components/avatar)
- [Company mark](https://notchset.dev/components/company-mark)

## Source

### components/ui/notchset/brand-lockup.tsx

```tsx
// Notchset brand-lockup 2.0.0 · https://notchset.dev/changelog
import * as React from "react";
import { cn } from "@/lib/utils";

/*
 * The brand, drawn once: the plus, then the lowercase wordmark in the display face at 650, tight tracking. Every
 * template draws its company this way and nowhere else (LANGUAGE.md, section 5). The plus is the Signature
 * (`--ns-signal`), so it follows the template's look and the theme; the wordmark is ink. A buyer swaps in their own
 * brand in one place: `name` for the wordmark, `mark` for a different glyph. Self-contained on purpose: the site's
 * animated logo (src/components/site/logo.tsx) draws the same shapes but templates never import the site.
 * Customer companies are a different thing (CompanyMark).
 */
const PLUS = "M30.5 43.5H69.5Q72 43.5 72 46V54Q72 56.5 69.5 56.5H30.5Q28 56.5 28 54V46Q28 43.5 30.5 43.5Z M46 28H54Q56.5 28 56.5 30.5V69.5Q56.5 72 54 72H46Q43.5 72 43.5 69.5V30.5Q43.5 28 46 28Z";

type BrandSize = "sm" | "md" | "lg";
const TEXT: Record<BrandSize, string> = { sm: "text-[13px]", md: "text-[15px]", lg: "text-[18px]" };

type BrandMarkProps = {
  /** Edge in px. Defaults to 12. */
  size?: number | undefined;
  className?: string | undefined;
};

/** The plus, still, in the colour it inherits (`currentColor`). */
function BrandMark({ size = 12, className }: BrandMarkProps) {
  return (
    <svg data-slot="brand-mark" width={size} height={size} viewBox="28 28 44 44" fill="currentColor" aria-hidden className={cn("block shrink-0", className)}>
      <path d={PLUS} />
    </svg>
  );
}

type BrandLockupProps = {
  size?: BrandSize | undefined;
  /** The wordmark. Defaults to "Notchset"; it is always drawn lowercase. */
  name?: string | undefined;
  /** A different mark in place of the plus (sized to the lockup, coloured by the Signature). */
  mark?: React.ReactNode;
  className?: string | undefined;
};

/** The mark and the wordmark. The plus stands about a pixel taller than the letters; the gap is about two bar widths. */
function BrandLockup({ size = "md", name = "Notchset", mark, className }: BrandLockupProps) {
  return (
    <span data-slot="brand-lockup" className={cn("inline-flex min-w-0 items-center gap-[0.5em] leading-none text-[var(--ns-ink)]", TEXT[size], className)}>
      <span aria-hidden className="inline-flex shrink-0 items-center text-[var(--ns-signal)] [&>svg]:size-[0.84em]">
        {mark ?? <BrandMark size={12} className="size-[0.84em]" />}
      </span>
      <span className="truncate font-[family-name:var(--ns-font-display)] font-[650] tracking-[-0.055em] whitespace-nowrap lowercase">{name}</span>
    </span>
  );
}

export { BrandLockup, BrandMark, type BrandLockupProps, type BrandMarkProps };
```

The foundation (the tokens listed above, keyframes and motion levels) installs once with the first component; its CSS is public at https://notchset.dev/r/notchset-foundation.json.