Skip to main content

Type Alias: AdwFlapProps

AdwFlapProps = WidgetProps & object

Defined in: generated/jsx.ts:4269

Props for the AdwFlap widget.

Type Declaration

NameTypeDescriptionDefined in
children?ReactNode-generated/jsx.ts:4365
content?Gtk.Widget | nullThe content widget. It's always displayed when unfolded, and partially visible when folded.generated/jsx.ts:4275
flap?Gtk.Widget | nullThe flap widget. It's only visible when AdwFlap.reveal-progress is greater than 0.generated/jsx.ts:4281
flapPosition?Gtk.PackTypeThe flap position. If it's set to GTK_PACK_START, the flap is displayed before the content, if GTK_PACK_END, it's displayed after the content.generated/jsx.ts:4288
foldDuration?numberThe fold transition animation duration, in milliseconds.generated/jsx.ts:4290
foldPolicy?Adw.FlapFoldPolicyThe fold policy for the flap.generated/jsx.ts:4292
foldThresholdPolicy?Adw.FoldThresholdPolicyDetermines when the flap will fold. If set to ADW_FOLD_THRESHOLD_POLICY_MINIMUM, flap 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:4303
locked?booleanWhether the flap is locked. If FALSE, folding when the flap is revealed automatically closes it, and unfolding it when the flap is not revealed opens it. If TRUE, AdwFlap.reveal-flap value never changes on its own.generated/jsx.ts:4311
modal?booleanWhether the flap is modal. If TRUE, clicking the content widget while flap is revealed, as well as pressing the Esc key, will close the flap. If FALSE, clicks are passed through to the content widget.generated/jsx.ts:4319
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:4371
orientation?Gtk.OrientationThe orientation of the orientable.generated/jsx.ts:4364
ref?Ref<Adw.Flap>-generated/jsx.ts:4392
revealFlap?booleanWhether the flap widget is revealed.generated/jsx.ts:4321
revealParams?Adw.SpringParamsThe reveal animation spring parameters. The default value is equivalent to: adw_spring_params_new (1, 0.5, 500)generated/jsx.ts:4331
separator?Gtk.Widget | nullThe separator widget. It's displayed between content and flap when there's no shadow to display. When exactly it's visible depends on the AdwFlap.transition-type value.generated/jsx.ts:4339
swipeToClose?booleanWhether the flap can be closed with a swipe gesture. The area that can be swiped depends on the AdwFlap.transition-type value.generated/jsx.ts:4346
swipeToOpen?booleanWhether the flap can be opened with a swipe gesture. The area that can be swiped depends on the AdwFlap.transition-type value.generated/jsx.ts:4353
transitionType?Adw.FlapTransitionTypethe type of animation used for reveal and fold transitions. AdwFlap.flap is transparent by default, which means the content will be seen through it with ADW_FLAP_TRANSITION_TYPE_OVER transitions; add the .background style class to it if this is unwanted.generated/jsx.ts:4362