Adw/io.github.gardencompose.adw.components/OverlaySplitView

OverlaySplitView

@Composable

fun OverlaySplitView(sidebar: @Composable OverlaySplitViewScope.() -> Unit, modifier: Modifier = Modifier, collapsed: Boolean = false, pinSidebar: Boolean = false, sidebarPosition: PackType = PackType.START, sidebarWidthFraction: Double = 0.25, maxSidebarWidth: Double = 280.0, minSidebarWidth: Double = 180.0, sidebarWidthUnit: LengthUnit = LengthUnit.SP, enableHideGesture: Boolean = true, enableShowGesture: Boolean = true, content: @Composable OverlaySplitViewScope.() -> Unit)

Creates a org.gnome.adw.OverlaySplitView that presents a sidebar and content side by side or as an overlay.

Parameters

sidebar

Composable widget displayed as the sidebar.

modifier

Compose Modifier for layout and styling.

collapsed

Whether the split view is collapsed.

pinSidebar

Whether the sidebar widget is pinned.

sidebarPosition

The sidebar position.

sidebarWidthFraction

The preferred sidebar width as a fraction of the total width.

maxSidebarWidth

The maximum sidebar width.

minSidebarWidth

The minimum sidebar width.

sidebarWidthUnit

The length unit for minimum and maximum sidebar widths.

enableHideGesture

Whether the sidebar can be closed with a swipe gesture.

enableShowGesture

Whether the sidebar can be opened with an edge swipe gesture.

content

The composable content to display inside the view.