API reference

Header values

The values returned by useCollapsibleHeader.

Library source ↗

Type: CollapsibleHeader. View library source.

scrollY

Required

SharedValue<number>

Active page's scroll position (shared value).

headerHeight

Required

SharedValue<number>

Collapsing-header height: the initial estimate until layout provides a measurement. Zero without a header.

collapseProgress

Required

DerivedValue<number>

0 = fully expanded, 1 = fully collapsed (derived, clamped). Remains 0 when header height is 0.

pinnedHeaderHeight

Required

number

Pinned header height (excludes the safe-area top inset).

tabBarHeight

Required

number

Tab bar height.

topInset

Required

number

Reserved top inset (the device safe area unless Container.topInset overrides it).

contentTop

Required

number

Fixed chrome height when the collapsing header is fully collapsed (pinned header + top inset + tab bar). Excludes the collapsing header. Handy for positioning a custom sticky element or a RefreshControl.

Hooks

Read the header and tab state inside your components.

Tab bar values

The values supplied to your renderTabBar function.