Skip to main content

Type Alias: AdwLeafletProps

AdwLeafletProps = WidgetProps & object

Defined in: generated/jsx.ts:5910

Props for the AdwLeaflet widget.

Type Declaration

NameTypeDescriptionDefined in
canNavigateBack?booleanWhether gestures and shortcuts for navigating backward are enabled. The supported gestures are: - One-finger swipe on touchscreens - Horizontal scrolling on touchpads (usually two-finger swipe) - Back/forward mouse buttons The keyboard back/forward keys are also supported, as well as the Alt+ shortcut for horizontal orientation, or Alt+ for vertical orientation. If the orientation is horizontal, for right-to-left locales, gestures and shortcuts are reversed. Only children that have AdwLeafletPage.navigatable set to TRUE can be navigated to.generated/jsx.ts:5930
canNavigateForward?booleanWhether gestures and shortcuts for navigating forward are enabled. The supported gestures are: - One-finger swipe on touchscreens - Horizontal scrolling on touchpads (usually two-finger swipe) - Back/forward mouse buttons The keyboard back/forward keys are also supported, as well as the Alt+ shortcut for horizontal orientation, or Alt+ for vertical orientation. If the orientation is horizontal, for right-to-left locales, gestures and shortcuts are reversed. Only children that have AdwLeafletPage.navigatable set to TRUE can be navigated to.generated/jsx.ts:5950
canUnfold?booleanWhether or not the leaflet can unfold.generated/jsx.ts:5952
children?ReactNode-generated/jsx.ts:6008
childTransitionParams?Adw.SpringParamsThe child transition spring parameters. The default value is equivalent to: adw_spring_params_new (1, 0.5, 500)generated/jsx.ts:5962
foldThresholdPolicy?Adw.FoldThresholdPolicyDetermines when the leaflet will fold. If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM, it will only fold when the children cannot fit anymore. With ADW_FOLD_THRESHOLD_POLICY_NATURAL, it will fold as soon as children don't get their natural size. This can be useful if you have a long ellipsizing label and want to let it ellipsize instead of immediately folding.generated/jsx.ts:5973
homogeneous?booleanWhether the leaflet allocates the same size for all children when folded. If set to FALSE, different children can have different size along the opposite orientation.generated/jsx.ts:5980
modeTransitionDuration?numberThe mode transition animation duration, in milliseconds.generated/jsx.ts:5982
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:6014
orientation?Gtk.OrientationThe orientation of the orientable.generated/jsx.ts:6007
ref?Ref<Adw.Leaflet>-generated/jsx.ts:6031
transitionType?Adw.LeafletTransitionTypeThe type of animation used for transitions between modes and children. The transition type can be changed without problems at runtime, so it is possible to change the animation based on the mode or child that is about to become current.generated/jsx.ts:5990
visibleChild?Gtk.Widget | nullThe widget currently visible when the leaflet is folded. The transition is determined by AdwLeaflet.transition-type and AdwLeaflet.child-transition-params. The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.generated/jsx.ts:5999
visibleChildName?string | nullThe name of the widget currently visible when the leaflet is folded. See AdwLeaflet.visible-child.generated/jsx.ts:6005