Skip to main content

Type Alias: GtkAssistantProps

GtkAssistantProps = Omit<GtkWindowProps, "onNotify"> & object

Defined in: generated/jsx.ts:1723

Props for the GtkAssistant widget.

Type Declaration

NameTypeDescriptionDefined in
children?ReactNode-generated/jsx.ts:1756
onApply()?(self) => void | nullEmitted when the apply button is clicked. The default behavior of the GtkAssistant is to switch to the page after the current page, unless the current page is the last one. A handler for the ::apply signal should carry out the actions for which the wizard has collected data. If the action takes a long time to complete, you might consider putting a page of type %GTK_ASSISTANT_PAGE_PROGRESS after the confirmation page and handle this operation within the Assistant.:prepare signal of the progress page.generated/jsx.ts:1737
onCancel()?(self) => void | nullEmitted when then the cancel button is clicked.generated/jsx.ts:1739
onClose()?(self) => void | nullEmitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type %GTK_ASSISTANT_PAGE_CONFIRM) is clicked.generated/jsx.ts:1745
onEscape()?(self) => void | nullThe action signal for the Escape binding.generated/jsx.ts:1747
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:1762
onPrepare()?(self, page) => void | nullEmitted when a new page is set as the assistant's current page, before making the new page visible. A handler for this signal can do any preparations which are necessary before showing page.generated/jsx.ts:1755
ref?Ref<Gtk.Assistant>-generated/jsx.ts:1763