# @fayegram-ai/faye-ui/hooks/scroll-trigger

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

## Import

```tsx
import { useScrollTrigger } from '@fayegram-ai/faye-ui/hooks/scroll-trigger';
```

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

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

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `useScrollTrigger` | value | `({ target, targetRef, threshold, hysteresis, reducedMotion }?: ScrollTriggerOptions) => { scrollToTop: (behavior?: ScrollBehavior) => void; offset: number; direction: "up" \| "down"; triggered: boolean; scrolled: boolean; }` |
| `ScrollTriggerOptions` | type | `ScrollTriggerOptions` |



## 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/scroll-trigger.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.