# Button

shadcn's button in Candor's theme, with a locked state for <Locked> (dimmed, and says why).

- Registry name: `button` (`@candor/button`)
- Tier: Free (MIT). No licence key needed.
- Docs: https://candor.themethodic.com/docs/button

## Install

```bash
npx candor-ui add button
```

Run `npx candor-ui@latest init` once first (https://candor.themethodic.com/get-started.md). Without the CLI: `npx shadcn@latest add @candor/button`.
It brings in: render-prop, utils.
npm packages: class-variance-authority@^0.7.1, radix-ui@^1.8.1.

## Example

```tsx
"use client"

import { Button } from "@/components/ui/button"

export default function Example() {
  return (
    <div className="flex flex-wrap items-center gap-3">
      <Button>Approve</Button>
      <Button variant="outline">Ask for changes</Button>
      <Button variant="ghost">Cancel</Button>
      <Button variant="destructive">Delete history</Button>
      <Button size="sm" asChild>
        <a href="#queue">Open the queue</a>
      </Button>
    </div>
  )
}
```

## <Button>

Props:

- `asChild?: boolean | undefined`: Render the child element (a link, say) with the button's styles instead of a <button>.

Also takes the props of `React.ComponentProps<"button">`, `VariantProps<typeof buttonVariants>`, `RenderProp`.

## 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` (fixed strings) and `TermsProvider` (nouns); entity kinds and agent roles in `EntityKindsProvider` and `AgentRolesProvider`.