Skip to main content
Version: 1.x

HeaderMotion

The root provider for a header-motion setup. It tracks header measurements, derives the shared progress value, and exposes the compound subcomponents.

Usage

import HeaderMotion from 'react-native-header-motion';

<HeaderMotion>{/* Header, Bridge, ScrollView, etc. */}</HeaderMotion>;

Props

PropTypeDefaultDescription
progressThresholdnumber | (measuredDynamic: number) => number(h) => hCollapse distance in pixels. When a function, it receives the measured dynamic height.
measureDynamic(e: LayoutChangeEvent) => numberheight from layoutControls what value is read from Header.Dynamic's layout event.
measureDynamicMode'mount' | 'update''mount''mount' measures once. 'update' re-measures on subsequent layouts.
activeScrollIdSharedValue<string>Identifies which scrollable owns progress in multi-scroll setups.
progressExtrapolationExtrapolationTypeExtrapolation.CLAMPControls how progress behaves outside [0, 1].
childrenReactNodeComponents participating in header motion.

Compound components

Access subcomponents as properties of the default export:

  • HeaderMotion.Header
  • HeaderMotion.Header.Dynamic
  • HeaderMotion.Bridge
  • HeaderMotion.NavigationBridge
  • HeaderMotion.ScrollView
  • HeaderMotion.FlatList
  • HeaderMotion.ScrollManager