Type Alias: AdwOverlaySplitViewProps
AdwOverlaySplitViewProps =
WidgetProps&object
Defined in: generated/jsx.ts:5666
Props for the AdwOverlaySplitView widget.
Type Declaration
| Name | Type | Description | Defined in |
|---|---|---|---|
children? | ReactNode | - | generated/jsx.ts:5745 |
collapsed? | boolean | Whether the split view is collapsed. When collapsed, the sidebar widget is presented as an overlay above the content widget, otherwise they are displayed side by side. | generated/jsx.ts:5673 |
content? | Gtk.Widget | null | The content widget. | generated/jsx.ts:5675 |
enableHideGesture? | boolean | Whether the sidebar can be closed with a swipe gesture. Only touchscreen swipes are supported. | generated/jsx.ts:5681 |
enableShowGesture? | boolean | Whether the sidebar can be opened with an edge swipe gesture. Only touchscreen swipes are supported. | generated/jsx.ts:5687 |
maxSidebarWidth? | number | The maximum sidebar width. Maximum width is affected by AdwOverlaySplitView.sidebar-width-unit. The sidebar widget can still be allocated with larger width if its own minimum width exceeds it. | generated/jsx.ts:5697 |
minSidebarWidth? | number | The minimum sidebar width. Minimum width is affected by AdwOverlaySplitView.sidebar-width-unit. The sidebar widget can still be allocated with larger width if its own minimum width exceeds it. | generated/jsx.ts:5707 |
pinSidebar? | boolean | Whether the sidebar widget is pinned. By default, collapsing self automatically hides the sidebar widget, and uncollapsing it shows the sidebar. If set to TRUE, sidebar visibility never changes on its own. | generated/jsx.ts:5715 |
ref? | Ref<Adw.OverlaySplitView> | - | generated/jsx.ts:5746 |
showSidebar? | boolean | Whether the sidebar widget is shown. | generated/jsx.ts:5717 |
sidebar? | Gtk.Widget | null | The sidebar widget. | generated/jsx.ts:5719 |
sidebarPosition? | Gtk.PackType | The sidebar position. If it's set to GTK_PACK_START, the sidebar is displayed before the content, if GTK_PACK_END, it's displayed after the content. | generated/jsx.ts:5726 |
sidebarWidthFraction? | number | The preferred sidebar width as a fraction of the total width. The preferred width is additionally limited by AdwOverlaySplitView.min-sidebar-width and AdwOverlaySplitView.max-sidebar-width. The sidebar widget can be allocated with larger width if its own minimum width exceeds the preferred width. | generated/jsx.ts:5737 |
sidebarWidthUnit? | Adw.LengthUnit | The length unit for minimum and maximum sidebar widths. See AdwOverlaySplitView.min-sidebar-width and AdwOverlaySplitView.max-sidebar-width. | generated/jsx.ts:5744 |