Skip to main content

Types

SheetDetent

<TrueSheet detents={['auto', 0.8, 1]}>
<View />
</TrueSheet>
ValueDescription🍎🤖
"auto"Auto resize based on content height.16+
numberFractional height (0-1) representing percentage of screen height.

TrueSheetGrabberProps

Grabber props to be used for android grabber or handle.

PropTypeDefaultDescription
visiblebooleantrueIs grabber visible.
colorColorValue"rgba(73,69,79,0.4)"Grabber color according to M3 specs.
heightnumber4Grabber height according to M3 specs.
widthnumber32Grabber width according to M3 specs.
topOffsetnumber0Grabber top position offset.

BlurTint

Blur tint that is mapped into native values in IOS.

<TrueSheet blurTint="dark">
<View />
</TrueSheet>
Value
"light"
"dark"
"default"
"extraLight"
"regular"
"prominent"
"systemUltraThinMaterial"
"systemThinMaterial"
"systemMaterial"
"systemThickMaterial"
"systemChromeMaterial"
"systemUltraThinMaterialLight"
"systemThinMaterialLight"
"systemMaterialLight"
"systemThickMaterialLight"
"systemChromeMaterialLight"
"systemUltraThinMaterialDark"
"systemThinMaterialDark"
"systemMaterialDark"
"systemThickMaterialDark"
"systemChromeMaterialDark"

DetentInfoEventPayload

Object that comes with most sheet events.

{
index: 1,
position: 123.5
}
PropertyTypeDescription
indexnumberThe detent index from the provided detents. See detents prop.
positionnumberThe Y position of the sheet relative to the screen.

PositionChangeEventPayload

Object that comes with the onPositionChange event. Extends DetentInfoEventPayload.

{
index: 1,
position: 123.5,
transitioning: false
}
PropertyTypeDescription
indexnumberThe detent index from the provided detents. See detents prop.
positionnumberThe Y position of the sheet relative to the screen.
transitioningbooleanWhether the sheet is currently transitioning (presenting or dismissing). When true, position updates are animated on iOS.