API Reference / @gtkx/navigation / useSplitViewCollapsed

Function: useSplitViewCollapsed()

useSplitViewCollapsed(): boolean

Defined in: packages/navigation/src/split-view/split-view-collapsed.ts:11

Returns whether the surrounding split view navigator shows one pane at a time, for its sidebar and content screens. It follows the split view's collapsed property, so it holds for both the collapsed prop and collapseCondition, and changes after libadwaita has laid out the collapsed or widened panes. Use it to adapt a screen's presentation, such as switching an AdwSidebar to Adw.SidebarMode.PAGE.

Returns

boolean