Skip to main content

Type Alias: AdwNavigationViewProps

AdwNavigationViewProps = WidgetProps & object

Defined in: generated/jsx.ts:5480

Props for the AdwNavigationView widget.

Type Declaration

NameTypeDescriptionDefined in
animateTransitions?booleanWhether to animate page transitions. Gesture-based transitions are always animated.generated/jsx.ts:5486
children?ReactNode-generated/jsx.ts:5554
hhomogeneous?booleanWhether the view is horizontally homogeneous. If the view is horizontally homogeneous, it allocates the same width for all pages. If it's not, the page may change width when a different page becomes visible.generated/jsx.ts:5496
history?string[] | nullArray of page IDs representing the navigation stack. The last ID is the visible page.generated/jsx.ts:5551
onGetNextPage?(self) => Adw.NavigationPage | nullEmitted when a push shortcut or a gesture is triggered. To support the push shortcuts and gestures, the application is expected to return the page to push in the handler. This signal can be emitted multiple times for the gestures, for example when the gesture is cancelled by the user. As such, the application must not make any irreversible changes in the handler, such as removing the page from a forward stack. Instead, it should be done in the AdwNavigationView.:pushed handler.generated/jsx.ts:5527
onHistoryChanged?(history) => void | nullCalled when the navigation history changes due to user interaction (back button, swipe gesture).generated/jsx.ts:5553
onPopped?(page, self) => void | nullEmitted after page has been popped from the navigation stack. See NavigationViewpop. When using NavigationViewpop_to_page or NavigationViewpop_to_tag, this signal is emitted for each of the popped pages.generated/jsx.ts:5537
onPushed?(self) => void | nullEmitted after a page has been pushed to the navigation stack. See NavigationViewpush.generated/jsx.ts:5543
onReplaced?(self) => void | nullEmitted after the navigation stack has been replaced. See NavigationViewreplace.generated/jsx.ts:5549
popOnEscape?booleanWhether pressing Escape pops the current page. Applications using AdwNavigationView to implement a browser may want to disable it.generated/jsx.ts:5503
ref?Ref<Adw.NavigationView>-generated/jsx.ts:5555
vhomogeneous?booleanWhether the view is vertically homogeneous. If the view is vertically homogeneous, it allocates the same height for all pages. If it's not, the view may change height when a different page becomes visible.generated/jsx.ts:5513