# Initials

The first letter of each of the first two words of a name, upper-cased in `locale` ("Sam Rivera" is "SR"; "ilker" is "İ" in Turkish, "I" in English). Pass the page's language, `useLocale().locale`, as Candor's components do; left out, or not a language the browser knows, the letters are upper-cased the same in every language, so the server and the browser agree. PersonMenu and Board draw a person's initials with it; `person-menu` still exports it for apps that import it from there.

- Registry name: `initials` (`@candor/initials`)
- Tier: Pro. Installing it needs a Pro, Premium or Team licence key: the person runs `npx candor-ui key <key>` themselves; never ask for the key in chat or write it to a file.
- Docs: https://candor.themethodic.com/docs/initials

## Install

```bash
npx candor-ui add initials
```

Run `npx candor-ui@latest init` once first (https://candor.themethodic.com/get-started.md). Without the CLI: `npx shadcn@latest add @candor/initials`.
It brings in: tokens.

## Functions

### initialsOf

```ts
initialsOf(name: string, locale?: string | undefined)
```

## Rules for using Candor UI

- Components take plain typed data. Never pass model output as HTML or render it as a link; messages are typed blocks.
- A control that can't be used says why: wrap it in `<Locked reason="…">`, don't just disable it.
- Don't show a value you don't have: leave it out (it renders as —) rather than guess. An estimate is labelled as one.
- Nothing is pre-selected in a decision a person makes, and the agent is named from your app's data, never from model output.
- Your app's words go in `LocaleProvider`: its fixed strings in `strings`, its nouns in `nouns`; entity kinds and agent roles in `EntityKindsProvider` and `AgentRolesProvider`.