Skip to content
GuidesToolkitAPI

FloatingPanelProps

FloatingPanelProps = ViewProps & object

Defined in: packages/expo-arcgis-toolkit/src/FloatingPanel.tsx:31

Type Declaration

Section titled “Type Declaration”

attributionBarHeight?

Section titled “attributionBarHeight?”

optional attributionBarHeight?: number

The height of the attribution bar at the bottom of the view, which the panel stays above outside portrait.

Default

Section titled “Default”

the attribution bar of geoView, or 0 without one

backgroundColor?

Section titled “backgroundColor?”

optional backgroundColor?: ColorValue

The panel’s background color.

Default

Section titled “Default”
the system background color

children?

Section titled “children?”

optional children?: ReactNode

The panel’s content. React lays it out in the panel’s size: give it flex: 1 to fill the panel.

geoView?

Section titled “geoView?”

optional geoView?: RefObject<GeoViewHandle | null>

The view the panel floats over, whose attribution bar it stays above: a <MapView>, <SceneView> or <LocalSceneView> ref.

Default

Section titled “Default”
the view the panel is placed in

horizontalAlignment?

Section titled “horizontalAlignment?”

optional horizontalAlignment?: "leading" | "center" | "trailing"

Where the panel sits across the view, outside portrait: in portrait it spans the view’s width.

Default

Section titled “Default”
'trailing'

isPresented?

Section titled “isPresented?”

optional isPresented?: boolean

Whether the panel shows.

Default

Section titled “Default”
true

maxWidth?

Section titled “maxWidth?”

optional maxWidth?: number

The panel’s maximum width outside portrait.

Default

Section titled “Default”
400

onSelectedDetentChange?

Section titled “onSelectedDetentChange?”

optional onSelectedDetentChange?: (detent) => void

Called with the detent the user dragged the panel to.

Parameters

Section titled “Parameters”
detent
Section titled “detent”

FloatingPanelDetent

Returns

Section titled “Returns”

void

selectedDetent?

Section titled “selectedDetent?”

optional selectedDetent?: FloatingPanelDetent

The height the panel rests at. The user can drag the panel to 'summary', 'half' or 'full', which onSelectedDetentChange reports; to keep the two in step, set it from there.

Default

Section titled “Default”
'half', the Toolkit's