# @fayegram-ai/faye-ui/hooks/click-away

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

## Import

```tsx
import { ClickAwayListener } from '@fayegram-ai/faye-ui/hooks/click-away';
```

[Usage and behavior guide](/docs/utilities/) · [API JSON](/api/packages/hooks/click-away.json)

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

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `ClickAwayListener` | value | `({ onClickAway, enabled, branches, ownerDocument, children, ...props }: ClickAwayListenerProps) => import("react").JSX.Element` |
| `ClickAwayListenerProps` | type | `ClickAwayListenerProps` |

## ClickAwayListener

A structural wrapper for custom surfaces. Do not add a second dismiss listener to Base UI overlays.

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 |
|---|---|---|---|
| `branches` | No | `readonly RefObject<Element \| null>[] \| undefined` | Include portalled branches explicitly; DOM ancestry alone does not identify them. |
| `enabled` | No | `boolean \| undefined` | See the usage contract and declaration. |
| `onClickAway` | Yes | `(event: PointerEvent) => void` | See the usage contract and declaration. |
| `ownerDocument` | No | `Document \| undefined` | See the usage contract and declaration. |



## Defaults and customization

Defaults and native behavior are documented in the linked family guide. This reference does not infer a default from an optional property.

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/hooks/click-away.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.