# @fayegram-ai/faye-ui/feedback/badge-indicator

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

## Import

```tsx
import { BadgeIndicator } from '@fayegram-ai/faye-ui/feedback/badge-indicator';
```

[Usage and behavior guide](/docs/feedback/) · [API JSON](/api/packages/feedback/badge-indicator.json)

This entry has no declared client boundary; individual exported behavior still follows its rendering contract.

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `BadgeIndicator` | value | `({ profile, className, children, count, maximum, dot, showZero, label, position, overlap, tone, ...props }: BadgeIndicatorProps) => import("react").JSX.Element` |
| `BadgeIndicatorProps` | type | `BadgeIndicatorProps` |

## BadgeIndicator

Accessible text is caller supplied. The visual count is hidden from assistive technology.

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 |
|---|---|---|---|
| `children` | Yes | `ReactNode` | See the usage contract and declaration. |
| `count` | No | `number \| undefined` | See the usage contract and declaration. |
| `dot` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `label` | Yes | `string` | See the usage contract and declaration. |
| `maximum` | No | `number \| undefined` | See the usage contract and declaration. |
| `overlap` | No | `VisualVariant<"badge-indicator", "overlap"> \| undefined` | Circular artwork moves the badge inward to follow its perimeter. |
| `position` | No | `VisualVariant<"badge-indicator", "position"> \| undefined` | See the usage contract and declaration. |
| `profile` | No | `ComponentProfile \| undefined` | See the usage contract and declaration. |
| `ref` | No | `Ref<HTMLSpanElement> \| undefined` | See the usage contract and declaration. |
| `showZero` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `tone` | No | `VisualVariant<"badge-indicator", "tone"> \| undefined` | See the usage contract and declaration. |



## Defaults and customization

Descriptor defaults: `{"overlap":"rectangular","tone":"accent","position":"end"}`. Parts: `root`, `indicator`. 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/feedback/badge-indicator.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.