@gtkx/react

Functions

Function	Description
createPortal	Creates a portal that renders children into a different GTK widget container.
quit	Quits the GTK application and cleans up resources. Unmounts the React tree and stops the GTK main loop.
render	Renders a React element tree as a GTK application. This is the main entry point for GTKX applications.

Variables

Variable	Description
AboutDialog	Displays information about a program.
ActionBar	Presents contextual actions.
AppChooserButton	The GtkAppChooserButton lets the user select an application.
AppChooserDialog	GtkAppChooserDialog shows a GtkAppChooserWidget inside a GtkDialog.
AppChooserWidget	GtkAppChooserWidget is a widget for selecting applications.
ApplicationWindow	A GtkWindow subclass that integrates with GtkApplication.
AspectFrame	Preserves the aspect ratio of its child.
Assistant	GtkAssistant is used to represent a complex as a series of steps.
Box	Arranges child widgets into a single row or column.
Button	Calls a callback function when the button is clicked.
Calendar	Displays a Gregorian calendar, one month at a time.
CellView	A widget displaying a single row of a GtkTreeModel
CenterBox	Arranges three children in a row, keeping the middle child centered as well as possible.
CheckButton	Places a label next to an indicator.
ColorButton	The GtkColorButton allows to open a color chooser dialog to change the color.
ColorChooserDialog	A dialog for choosing a color.
ColorChooserWidget	The GtkColorChooserWidget widget lets the user select a color.
ColorDialogButton	Opens a color chooser dialog to select a color.
ColumnView	Presents a large dynamic list of items using multiple columns with headers.
ComboBox	A GtkComboBox is a widget that allows the user to choose from a list of valid choices.
ComboBoxText	A GtkComboBoxText is a simple variant of GtkComboBox for text-only use cases.
CONSTRUCTOR_PARAMS	-
createRef	-
Dialog	Dialogs are a convenient way to prompt the user for a small amount of input.
DragIcon	A GtkRoot implementation for drag icons.
DrawingArea	Allows drawing with cairo.
DropDown	Allows the user to choose an item from a list of options.
EditableLabel	Allows users to edit the displayed text by switching to an “edit mode”.
EmojiChooser	Used by text widgets to let users insert Emoji characters.
Entry	A single-line text entry widget.
Expander	Allows the user to reveal or conceal a child widget.
FileChooserDialog	GtkFileChooserDialog is a dialog suitable for use with “File Open” or “File Save” commands.
FileChooserWidget	GtkFileChooserWidget is a widget for choosing files.
Fixed	Places its child widgets at fixed positions and with fixed sizes.
FlowBox	Puts child widgets in a reflowing grid.
FlowBoxChild	The kind of widget that can be added to a GtkFlowBox.
FontButton	The GtkFontButton allows to open a font chooser dialog to change the font.
FontChooserDialog	The GtkFontChooserDialog widget is a dialog for selecting a font.
FontChooserWidget	The GtkFontChooserWidget widget lets the user select a font.
FontDialogButton	Opens a font chooser dialog to select a font.
Frame	Surrounds its child with a decorative frame and an optional label.
GLArea	Allows drawing with OpenGL.
GraphicsOffload	Bypasses gsk rendering by passing the content of its child directly to the compositor.
Grid	Arranges its child widgets in rows and columns.
GridView	Presents a large dynamic grid of items.
HeaderBar	Creates a custom titlebar for a window.
IconView	GtkIconView is a widget which displays data in a grid of icons.
Image	Displays an image.
InfoBar	GtkInfoBar can be used to show messages to the user without a dialog.
Inscription	Shows text in a predefined area.
Label	Displays a small amount of text.
LevelBar	Shows a level indicator.
LinkButton	A button with a hyperlink.
ListBase	The abstract base class for GTK's list widgets.
ListBox	Shows a vertical list.
ListBoxRow	The kind of widget that can be added to a GtkListBox.
ListView	Presents a large dynamic list of items.
LockButton	GtkLockButton is a widget to obtain and revoke authorizations needed to operate the controls.
MediaControls	Shows controls for video playback.
MenuButton	Displays a popup when clicked.
MessageDialog	GtkMessageDialog presents a dialog with some message text.
Notebook	Switches between children using tabs.
Overlay	Places “overlay” widgets on top of a single main child.
PageSetupUnixDialog	Presents a page setup dialog for platforms which don’t provide a native page setup dialog, like Unix.
Paned	Arranges its children in two panes, horizontally or vertically.
PasswordEntry	A single-line text entry widget for entering passwords and other secrets.
Picture	Displays a GdkPaintable.
Popover	Presents a bubble-like popup.
PopoverMenu	A subclass of GtkPopover that implements menu behavior.
PopoverMenuBar	Presents a horizontal bar of items that pop up menus when clicked.
PrintUnixDialog	A print dialog for platforms which don’t provide a native print dialog, like Unix.
ProgressBar	Displays the progress of a long-running operation.
Range	Base class for widgets which visualize an adjustment.
reconciler	The singleton GTKX React reconciler instance.
Revealer	Animates the transition of its child from invisible to visible.
Scale	Allows to select a numeric value with a slider control.
ScaleButton	Provides a button which pops up a scale widget.
Scrollbar	Shows a horizontal or vertical scrollbar.
ScrolledWindow	Makes its child scrollable.
SearchBar	Reveals a search entry when search is started.
SearchEntry	A single-line text entry widget for use as a search entry.
Separator	Draws a horizontal or vertical line to separate other widgets.
SETTER_GETTERS	-
ShortcutLabel	GtkShortcutLabel displays a single keyboard shortcut or gesture.
ShortcutsGroup	A GtkShortcutsGroup represents a group of related keyboard shortcuts or gestures.
ShortcutsSection	A GtkShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode.
ShortcutsShortcut	A GtkShortcutsShortcut represents a single keyboard shortcut or gesture with a short text.
ShortcutsWindow	A GtkShortcutsWindow shows information about the keyboard shortcuts and gestures of an application.
SpinButton	Allows to enter or change numeric values.
Spinner	Displays an icon-size spinning animation.
Stack	Shows one of its children at a time.
StackSidebar	Uses a sidebar to switch between GtkStack pages.
StackSwitcher	Shows a row of buttons to switch between GtkStack pages.
Statusbar	A GtkStatusbar widget is usually placed along the bottom of an application's main [class@Gtk.Window].
Switch	Shows a "light switch" that has two states: on or off.
Text	A single-line text entry.
TextView	Displays the contents of a [class@Gtk.TextBuffer].
ToggleButton	Shows a button which remains “pressed-in” when clicked.
TreeExpander	Provides an expander for a tree-like list.
TreeView	A widget for displaying both trees and lists
Video	Shows a GtkMediaStream with media controls.
Viewport	Implements scrollability for widgets that don't support scrolling on their own.
VolumeButton	GtkVolumeButton is a GtkScaleButton subclass tailored for volume control.
Widget	The base class for all widgets.
Window	A toplevel window which can contain other widgets.
WindowControls	Shows window frame controls.
WindowHandle	Implements titlebar functionality for a window.

Interfaces

Interface	Description
AboutDialogProps	Props for the AboutDialog widget.
ActionBarProps	Props for the ActionBar widget.
AppChooserButtonProps	Props for the AppChooserButton widget.
AppChooserDialogProps	Props for the AppChooserDialog widget.
AppChooserWidgetProps	Props for the AppChooserWidget widget.
ApplicationWindowProps	Props for the ApplicationWindow widget.
AspectFrameProps	Props for the AspectFrame widget.
AssistantProps	Props for the Assistant widget.
BoxProps	Props for the Box widget.
ButtonProps	Props for the Button widget.
CalendarProps	Props for the Calendar widget.
CellViewProps	Props for the CellView widget.
CenterBoxProps	Props for the CenterBox widget.
CheckButtonProps	Props for the CheckButton widget.
ColorButtonProps	Props for the ColorButton widget.
ColorChooserDialogProps	Props for the ColorChooserDialog widget.
ColorChooserWidgetProps	Props for the ColorChooserWidget widget.
ColorDialogButtonProps	Props for the ColorDialogButton widget.
ColumnViewProps	Props for the ColumnView widget.
ComboBoxProps	Props for the ComboBox widget.
ComboBoxTextProps	Props for the ComboBoxText widget.
DialogProps	Props for the Dialog widget.
DragIconProps	Props for the DragIcon widget.
DrawingAreaProps	Props for the DrawingArea widget.
DropDownProps	Props for the DropDown widget.
EditableLabelProps	Props for the EditableLabel widget.
EmojiChooserProps	Props for the EmojiChooser widget.
EntryProps	Props for the Entry widget.
ExpanderProps	Props for the Expander widget.
FileChooserDialogProps	Props for the FileChooserDialog widget.
FileChooserWidgetProps	Props for the FileChooserWidget widget.
FixedProps	Props for the Fixed widget.
FlowBoxChildProps	Props for the FlowBoxChild widget.
FlowBoxProps	Props for the FlowBox widget.
FontButtonProps	Props for the FontButton widget.
FontChooserDialogProps	Props for the FontChooserDialog widget.
FontChooserWidgetProps	Props for the FontChooserWidget widget.
FontDialogButtonProps	Props for the FontDialogButton widget.
FrameProps	Props for the Frame widget.
GLAreaProps	Props for the GLArea widget.
GraphicsOffloadProps	Props for the GraphicsOffload widget.
GridChildProps	-
GridProps	Props for the Grid widget.
GridViewProps	Props for the GridView widget.
HeaderBarProps	Props for the HeaderBar widget.
IconViewProps	Props for the IconView widget.
ImageProps	Props for the Image widget.
InfoBarProps	Props for the InfoBar widget.
InscriptionProps	Props for the Inscription widget.
LabelProps	Props for the Label widget.
LevelBarProps	Props for the LevelBar widget.
LinkButtonProps	Props for the LinkButton widget.
ListBaseProps	Props for the ListBase widget.
ListBoxProps	Props for the ListBox widget.
ListBoxRowProps	Props for the ListBoxRow widget.
ListItemProps	-
ListViewProps	Props for the ListView widget.
LockButtonProps	Props for the LockButton widget.
MediaControlsProps	Props for the MediaControls widget.
MenuButtonProps	Props for the MenuButton widget.
MessageDialogProps	Props for the MessageDialog widget.
NotebookProps	Props for the Notebook widget.
OverlayProps	Props for the Overlay widget.
PageSetupUnixDialogProps	Props for the PageSetupUnixDialog widget.
PanedProps	Props for the Paned widget.
PasswordEntryProps	Props for the PasswordEntry widget.
PictureProps	Props for the Picture widget.
PopoverMenuBarProps	Props for the PopoverMenuBar widget.
PopoverMenuProps	Props for the PopoverMenu widget.
PopoverProps	Props for the Popover widget.
PrintUnixDialogProps	Props for the PrintUnixDialog widget.
ProgressBarProps	Props for the ProgressBar widget.
RangeProps	Props for the Range widget.
RevealerProps	Props for the Revealer widget.
ScaleButtonProps	Props for the ScaleButton widget.
ScaleProps	Props for the Scale widget.
ScrollbarProps	Props for the Scrollbar widget.
ScrolledWindowProps	Props for the ScrolledWindow widget.
SearchBarProps	Props for the SearchBar widget.
SearchEntryProps	Props for the SearchEntry widget.
SeparatorProps	Props for the Separator widget.
ShortcutLabelProps	Props for the ShortcutLabel widget.
ShortcutsGroupProps	Props for the ShortcutsGroup widget.
ShortcutsSectionProps	Props for the ShortcutsSection widget.
ShortcutsShortcutProps	Props for the ShortcutsShortcut widget.
ShortcutsWindowProps	Props for the ShortcutsWindow widget.
SlotProps	-
SpinButtonProps	Props for the SpinButton widget.
SpinnerProps	Props for the Spinner widget.
StackProps	Props for the Stack widget.
StackSidebarProps	Props for the StackSidebar widget.
StackSwitcherProps	Props for the StackSwitcher widget.
StatusbarProps	Props for the Statusbar widget.
SwitchProps	Props for the Switch widget.
TextProps	Props for the Text widget.
TextViewProps	Props for the TextView widget.
ToggleButtonProps	Props for the ToggleButton widget.
TreeExpanderProps	Props for the TreeExpander widget.
TreeViewProps	Props for the TreeView widget.
VideoProps	Props for the Video widget.
ViewportProps	Props for the Viewport widget.
VolumeButtonProps	Props for the VolumeButton widget.
WidgetProps	The base class for all widgets.
WindowControlsProps	Props for the WindowControls widget.
WindowHandleProps	Props for the WindowHandle widget.
WindowProps	Props for the Window widget.