Skip to main content

Type Alias: GtkOverlayProps

GtkOverlayProps = WidgetProps & object

Defined in: generated/jsx.ts:6971

Props for the GtkOverlay widget.

Type Declaration

NameTypeDescriptionDefined in
child?Gtk.Widget | nullThe main child widget.generated/jsx.ts:6973
children?ReactNode-generated/jsx.ts:6991
onGetChildPosition()?(self, widget, allocation) => boolean | nullEmitted to determine the position and size of any overlay child widgets. A handler for this signal should fill allocation with the desired position and size for widget, relative to the 'main' child of overlay. The default handler for this signal uses the widget's halign and valign properties to determine the position and gives the widget its natural size (except that an alignment of %GTK_ALIGN_FILL will cause the overlay to be full-width/height). If the main child is a GtkScrolledWindow, the overlays are placed relative to its contents.generated/jsx.ts:6990
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:6997
ref?Ref<Gtk.Overlay>-generated/jsx.ts:6998