# @fayegram-ai/faye-ui/controls/button

Public exports and dependency-resolved component properties, with usage and rendering guidance.

## Import

```tsx
import { Button, IconButton, ButtonGroup } from '@fayegram-ai/faye-ui/controls/button';
```

[Usage and behavior guide](/docs/buttons/) · [API JSON](/api/packages/controls/button.json)

This entry declares a client boundary. Follow the rendering guide for framework integration.

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `Button` | value | `(input: ButtonProps) => import("react").JSX.Element` |
| `IconButton` | value | `({ className, pendingPosition, ...props }: IconButtonProps) => import("react").JSX.Element` |
| `ButtonGroup` | value | `(input: ButtonGroupProps) => import("react").JSX.Element` |
| `ButtonVariantOverrides` | type | `ButtonVariantOverrides` |
| `ButtonToneOverrides` | type | `ButtonToneOverrides` |
| `ButtonSizeOverrides` | type | `ButtonSizeOverrides` |
| `ButtonTone` | type | `ButtonTone` |
| `ButtonSize` | type | `ButtonSize` |
| `ButtonVariant` | type | `ButtonVariant` |
| `ButtonProps` | type | `ButtonProps` |
| `IconButtonProps` | type | `IconButtonProps` |
| `ButtonGroupProps` | type | `ButtonGroupProps` |

## Button

Public component; use the linked family guide for complete composition and behavior.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

### Properties

| Property | Required | Type | Meaning |
|---|---|---|---|
| `className` | No | `string \| ((state: ButtonState) => string \| undefined) \| undefined` | CSS class applied to the element, or a function that returns a class based on the component's state. |
| `endIcon` | No | `ReactNode` | See the usage contract and declaration. |
| `focusableWhenDisabled` | No | `boolean \| undefined` | Whether the button should be focusable when disabled. |
| `fullWidth` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `nativeButton` | No | `boolean \| undefined` | Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (for example, `<div>`). |
| `pending` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `pendingIndicator` | No | `ReactNode` | See the usage contract and declaration. |
| `pendingPosition` | No | `"center" \| "start" \| "end" \| undefined` | Center replaces the label without a size change; start/end reserve an indicator slot. |
| `render` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ButtonState> \| undefined` | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
| `size` | No | `ButtonSize \| undefined` | See the usage contract and declaration. |
| `startIcon` | No | `ReactNode` | Decorative slots keep artwork and labels centered with the same gap on either side. |
| `style` | No | `CSSProperties \| ((state: ButtonState) => React.CSSProperties \| undefined) \| undefined` | Style applied to the element, or a function that returns a style object based on the component's state. |
| `tone` | No | `ButtonTone \| undefined` | See the usage contract and declaration. |
| `variant` | No | `ButtonVariant \| undefined` | See the usage contract and declaration. |



## IconButton

Public component; use the linked family guide for complete composition and behavior.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

### Properties

| Property | Required | Type | Meaning |
|---|---|---|---|
| `aria-label` | Yes | `string` | Defines a string value that labels the current element. |
| `children` | Yes | `ReactNode` | See the usage contract and declaration. |
| `className` | No | `string \| ((state: ButtonState) => string \| undefined) \| undefined` | CSS class applied to the element, or a function that returns a class based on the component's state. |
| `endIcon` | No | `ReactNode` | See the usage contract and declaration. |
| `focusableWhenDisabled` | No | `boolean \| undefined` | Whether the button should be focusable when disabled. |
| `fullWidth` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `nativeButton` | No | `boolean \| undefined` | Whether the component renders a native `<button>` element when replacing it via the `render` prop. Set to `false` if the rendered element is not a button (for example, `<div>`). |
| `pending` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `pendingIndicator` | No | `ReactNode` | See the usage contract and declaration. |
| `pendingPosition` | No | `"center" \| "start" \| "end" \| undefined` | Center replaces the label without a size change; start/end reserve an indicator slot. |
| `render` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, ButtonState> \| undefined` | Allows you to replace the component's HTML element with a different tag, or compose it with another component. Accepts a `ReactElement` or a function that returns the element to render. |
| `size` | No | `ButtonSize \| undefined` | See the usage contract and declaration. |
| `startIcon` | No | `ReactNode` | Decorative slots keep artwork and labels centered with the same gap on either side. |
| `style` | No | `CSSProperties \| ((state: ButtonState) => React.CSSProperties \| undefined) \| undefined` | Style applied to the element, or a function that returns a style object based on the component's state. |
| `tone` | No | `ButtonTone \| undefined` | See the usage contract and declaration. |
| `variant` | No | `ButtonVariant \| undefined` | See the usage contract and declaration. |



## ButtonGroup

Public component; use the linked family guide for complete composition and behavior.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

### Properties

| Property | Required | Type | Meaning |
|---|---|---|---|
| `orientation` | No | `"horizontal" \| "vertical" \| undefined` | See the usage contract and declaration. |
| `ref` | No | `Ref<HTMLDivElement> \| undefined` | See the usage contract and declaration. |
| `size` | No | `ButtonSize \| undefined` | See the usage contract and declaration. |
| `tone` | No | `ButtonTone \| undefined` | See the usage contract and declaration. |
| `variant` | No | `ButtonVariant \| undefined` | See the usage contract and declaration. |



## Defaults and customization

Descriptor defaults: `{"variant":"outline","size":"md","tone":"neutral"}`. Parts: `root`, `label`, `indicator`, `start-icon`, `end-icon`. Explicit instance props take precedence over configured defaults.

Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.

## State, events and accessibility

For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.

## Declaration authority

Generated from `packages/faye-ui/dist/controls/button.d.ts` after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. [React DOM attributes](https://react.dev/reference/react-dom/components/common) and [Base UI component contracts](https://base-ui.com/react/overview/quick-start) describe the inherited foundations.