Skip to main content
Version: Unreleased

Configuration

Configuration props available for TrueSheet. Extends ViewProps.

<TrueSheet
  ref={sheet}
  detents={['auto', 0.8, 1]}
  backgroundColor="#696969"
  // ...
>
  <View />
</TrueSheet>

ref​

We use ref to reference our sheet and call the imperative methods. Learn more about refs here.

detents​

Array of detents you want the sheet to support. See this guide for example.

TypeDefault🍎🤖🌐
SheetDetent[][0.5, 1]✅✅✅
info

A sheet can only support up to 3 detents only! AKA collapsed, half-expanded, and expanded.

tip

It's recommended to sort detents from smallest to largest.

name​

The name to reference this sheet. It has to be unique. You can then present this sheet globally using its name. See this guide for example.

TypeDefault🍎🤖🌐
string✅✅✅

backgroundColor​

The sheet's background color. Uses the system default when not provided.

TypeDefault🍎🤖🌐
ColorValuesystem default✅✅✅
info

When not provided, iOS 26+ uses the default Liquid Glass effect, while iOS 18 and below uses the system background color. Android uses Material Design 3's colorSurfaceContainerLow which automatically adapts to light/dark mode.

On iOS 26.1+, setting this prop will override the default Liquid Glass effect.

backgroundBlur​

The blur effect style on iOS. When set, applies a blur effect over the backgroundColor. Example: "light", "dark", etc.

TypeDefault🍎🤖🌐
BackgroundBlur✅
info

On iOS 26.1+, setting this prop will override the default Liquid Glass effect.

blurOptions​

Options for customizing the blur effect. Only applies when backgroundBlur is set.

TypeDefault🍎🤖🌐
BlurOptions✅
<TrueSheet
  backgroundBlur="dark"
  blurOptions={{
    intensity: 80,
    interaction: false,
  }}
>
  <View />
</TrueSheet>

cornerRadius​

The sheet corner radius.

TypeDefault🍎🤖🌐
numbersystem default✅✅✅
info

When not provided, iOS uses the device's native corner radius automatically, while Android defaults to 16 (following Material Design 3 guidelines).

elevation​

The elevation (shadow depth) of the sheet.

TypeDefault🍎🤖🌐
number4✅✅

maxContentHeight​

The absolute maximum height of the sheet content, regardless of detents.

TypeDefault🍎🤖🌐
number✅✅✅

maxContentWidth​

The maximum width of the sheet content.

TypeDefault🍎🤖🌐
number✅✅✅
info

On Android and Web, the sheet defaults to a maximum width of 640dp. Setting this prop overrides that default. On iOS, the sheet uses the system default width.

note

This prop is ignored on phones in portrait orientation — the sheet always spans the full width.

anchor​

Anchors the sheet to the specified horizontal edge.

TypeDefault🍎🤖🌐
'left' | 'center' | 'right''center'✅✅✅
info

On iOS, the sheet uses sourceView to control horizontal positioning. System-defined margins prevent fully flush edge attachment.

note

This prop is ignored on phones in portrait orientation.

anchorOffset​

The offset from the screen edge. Only applies when anchor is 'left' or 'right'.

TypeDefault🍎🤖🌐
number16✅✅

dismissible​

If set to false, the sheet will prevent interactive dismissal via dragging or clicking outside of it.

TypeDefault🍎🤖🌐
booleantrue✅✅✅

draggable​

If set to false, the sheet will disable dragging to resize. The sheet can only be resized programmatically using the resize method.

TypeDefault🍎🤖🌐
booleantrue✅✅✅
info

When draggable is false, the grabber is automatically hidden.

dimmed​

Specify whether the sheet background is dimmed. Set to false to allow interaction with the background components.

TypeDefault🍎🤖🌐
booleantrue✅✅✅

dimmedDetentIndex​

The detent index that the sheet should start to dim the background.

TypeDefault🍎🤖🌐
number0✅✅✅
info

This is ignored if dimmed is set to false.

initialDetentIndex​

Initially present the sheet, after mounting, at a given detent index.

TypeDefault🍎🤖🌐
number-1✅✅✅

initialDetentAnimated​

Specify whether the sheet should animate after mounting. Used with initialDetentIndex.

TypeDefault🍎🤖🌐
booleantrue✅✅✅

lazy​

Specify whether the sheet content should mount lazily, on first presentation. Set to false to mount the content before presentation without presenting the sheet. Use this when content is not ready on the first render, then call present() after your readiness signal so auto detents measure the settled content.

TypeDefault🍎🤖🌐
booleantrue✅✅
note

Content that requires window attachment to measure, such as SwiftUI-hosted views, still only measures during presentation.

grabber​

Shows a native grabber (or drag handle) on the sheet.

TypeDefault🍎🤖🌐
booleantrue✅✅✅
info

iOS uses the native UISheetPresentationController grabber by default, while Android renders a native view following Material Design 3 specifications (32x4dp, centered, with the standard drag handle color).

When grabberOptions is provided, iOS uses a custom grabber view instead of the system default.

grabberOptions​

Options for customizing the grabber appearance. Only applies when grabber is true.

TypeDefault🍎🤖🌐
GrabberOptions✅✅
<TrueSheet
  grabber
  grabberOptions={{
    width: 48,
    height: 6,
    topMargin: 10,
    color: '#FF0000',
  }}
>
  <View />
</TrueSheet>
info

On iOS, when grabberOptions is not provided, the native system grabber is used. When any option is provided, a custom grabber view with vibrancy effect is rendered instead.

accessibilityOptions​

Options for customizing (e.g. localizing) the accessibility strings announced by screen readers.

TypeDefault🍎🤖🌐
AccessibilityOptions✅✅✅
<TrueSheet
  accessibilityOptions={{
    grabberLabel: 'Poignée de déplacement',
    expandedValue: 'Développé',
    collapsedValue: 'Réduit',
  }}
>
  <View />
</TrueSheet>
info

On iOS, the grabber strings only apply when grabberOptions is provided. Without it, iOS uses the system grabber which is already localized by the system.

A component that is fixed at the top of the sheet content. Useful for search bars, titles, or other header content. The header height is automatically accounted for in layout calculations. Accepts a functional Component or ReactElement. See this guide for example.

TypeDefault🍎🤖🌐
ComponentType<...> | ReactElement✅✅✅

headerStyle​

Style for the header container.

TypeDefault🍎🤖🌐
StyleProp<ViewStyle>✅✅✅

headerOptions​

Options for customizing header behavior.

TypeDefault🍎🤖🌐
HeaderOptions✅✅✅

A component that is pinned at the bottom of the sheet. The footer height is automatically accounted for in layout calculations. Accepts a functional Component or ReactElement. See this guide for example.

TypeDefault🍎🤖🌐
ComponentType<...> | ReactElement✅✅✅

footerStyle​

Style for the footer container.

TypeDefault🍎🤖🌐
StyleProp<ViewStyle>✅✅✅

footerOptions​

Options for customizing footer behavior.

TypeDefault🍎🤖🌐
FooterOptions✅✅✅

scrollableRef​

A ref to the scrollable component (e.g. ScrollView, FlatList) rendered within the sheet content. Required for scrollable handling — nested scrolling, keyboard insets, and auto detent sizing are wired to this scrollable. See this guide for more information.

TypeDefault🍎🤖🌐
RefObject<Component>✅✅✅

scrollableOptions​

Options for customizing scrollable behavior. Applies to the scrollable provided via scrollableRef. See this guide for more information.

TypeDefault🍎🤖🌐
ScrollableOptions✅✅✅

presentation​

Controls the sheet presentation style on iPad and web (landscape/tablet).

  • 'page': bottom-attached page sheet (full or readable width).
  • 'form': centered floating form sheet (default form-sheet width).

'form' is absolute — maxContentWidth is ignored when set.

TypeDefault🍎🤖🌐
'page' | 'form''page'17+✅

insetAdjustment​

Controls how the bottom safe area inset affects detent heights.

TypeDefault🍎🤖🌐
InsetAdjustment"automatic"✅✅

detached​

Renders the sheet as a detached floating card, not attached to the bottom edge.

TypeDefault🍎🤖🌐
booleanfalse✅

detachedOffset​

The offset from the bottom edge when detached is enabled.

TypeDefault🍎🤖🌐
number16✅

style​

The sheet's content style override.

Content lays out naturally by default — like a regular view or a screen. Pass flex: 1 to fill the sheet's visible height per detent.

TypeDefault🍎🤖🌐
StyleProp<ViewStyle>✅✅✅