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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
SheetDetent[] | [0.5, 1] | β | β | β |
A sheet can only support up to 3 detents only! AKA collapsed, half-expanded, and expanded.
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
string | β | β | β |
backgroundColorβ
The sheet's background color. Uses the system default when not provided.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
ColorValue | system default | β | β | β |
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
BackgroundBlur | β |
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
BlurOptions | β |
<TrueSheet
backgroundBlur="dark"
blurOptions={{
intensity: 80,
interaction: false,
}}
>
<View />
</TrueSheet>
cornerRadiusβ
The sheet corner radius.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | system default | β | β | β |
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | 4 | β | β |
maxContentHeightβ
The absolute maximum height of the sheet content, regardless of detents.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | β | β | β |
maxContentWidthβ
The maximum width of the sheet content.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | β | β | β |
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.
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
'left' | 'center' | 'right' | 'center' | β | β | β |
On iOS, the sheet uses sourceView to control horizontal positioning. System-defined margins prevent fully flush edge attachment.
This prop is ignored on phones in portrait orientation.
anchorOffsetβ
The offset from the screen edge. Only applies when anchor is 'left' or 'right'.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | 16 | β | β |
dismissibleβ
If set to false, the sheet will prevent interactive dismissal via dragging or clicking outside of it.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
boolean | true | β | β | β |
draggableβ
If set to false, the sheet will disable dragging to resize. The sheet can only be resized programmatically using the resize method.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
boolean | true | β | β | β |
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
boolean | true | β | β | β |
dimmedDetentIndexβ
The detent index that the sheet should start to dim the background.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | 0 | β | β | β |
This is ignored if dimmed is set to false.
initialDetentIndexβ
Initially present the sheet, after mounting, at a given detent index.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | -1 | β | β | β |
initialDetentAnimatedβ
Specify whether the sheet should animate after mounting.
Used with initialDetentIndex.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
boolean | true | β | β | β |
grabberβ
Shows a native grabber (or drag handle) on the sheet.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
boolean | true | β | β | β |
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
GrabberOptions | β | β |
<TrueSheet
grabber
grabberOptions={{
width: 48,
height: 6,
topMargin: 10,
color: '#FF0000',
}}
>
<View />
</TrueSheet>
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
AccessibilityOptions | β | β | β |
<TrueSheet
accessibilityOptions={{
grabberLabel: 'PoignΓ©e de dΓ©placement',
expandedValue: 'DΓ©veloppΓ©',
collapsedValue: 'RΓ©duit',
}}
>
<View />
</TrueSheet>
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.
headerβ
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
ComponentType<...> | ReactElement | β | β | β |
headerStyleβ
Style for the header container.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
StyleProp<ViewStyle> | β | β | β |
footerβ
A component that floats at the bottom of the sheet. Accepts a functional Component or ReactElement.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
ComponentType<...> | ReactElement | β | β | β |
footerStyleβ
Style for the footer container.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
StyleProp<ViewStyle> | β | β | β |
footerOptionsβ
Options for customizing footer behavior.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
FooterOptions | β | β |
scrollableβ
On iOS, automatically pins ScrollView or FlatList to fit within the sheet's available space. When enabled, the ScrollView's top edge will be pinned below any top sibling views, and its left, right, and bottom edges will be pinned to the container. See this guide for example.
On Android, it ensures the scroll view fills the available sheet space and automatically manages nested scrolling. Any nestedScrollEnabled prop on your ScrollView or FlatList is ignored when scrollable is enabled.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
boolean | false | β | β |
The auto detent is not supported with scrollable. Use fixed fractional detents (e.g., 0.5, 0.8, 1) instead.
scrollableOptionsβ
Options for customizing scrollable behavior. Only applies when scrollable is true.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
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.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
'page' | 'form' | 'page' | 17+ | β |
insetAdjustmentβ
Controls how the bottom safe area inset affects detent heights.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
InsetAdjustment | "automatic" | β | β |
detachedβ
Renders the sheet as a detached floating card, not attached to the bottom edge.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
boolean | false | β |
detachedOffsetβ
The offset from the bottom edge when detached is enabled.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
number | 16 | β |
styleβ
The sheet's container style override.
| Type | Default | π | π€ | π |
|---|---|---|---|---|
StyleProp<ViewStyle> | β | β | β |