@nodegui/react-nodegui

Index

Modules

• "react-proxy"

Classes

• RNAction
• RNGridColumn
• RNGridRow
• RNMenu
• RNMenuBar
• Renderer

Interfaces

• AbstractButtonProps
• ActionProps
• AnimatedImageProps
• BoxViewProps
• ButtonProps
• CheckBoxProps
• ComboBoxProps
• DataWithOffset
• DialProps
• GridViewProps
• ImageProps
• LineEditProps
• MenuBarProps
• MenuProps
• PlainTextEditProps
• ProgressBarProps
• RadioButtonProps
• ScrollAreaProps
• SliderProps
• SpinBoxProps
• SystemTrayIconProps
• TabItemProps
• TabProps
• TextProps
• ViewProps
• WindowProps

Type aliases

• Allowed
• ComboBoxItem
• Geometry
• GridColumnProps
• GridRowProps
• GridViewColumnProps
• GridViewRowProps
• KeysOfType
• NodeGuiReconciler
• OnlyType
• Position
• Range
• RendererOptions
• SetParentFunc
• Size
• ViewSize
• WidgetAttributesMap
• WidgetEventListeners
• WindowFlagsMap

Variables

• appProxy

Functions

• App
• getLoadedPixmap
• getLoadedQMovie
• hot
• offsetForIndex
• setAbstractButtonProps
• setActionProps
• setAnimatedImageProps
• setBoxViewProps
• setButtonProps
• setCheckBoxProps
• setComboBoxProps
• setDialProps
• setGridColumnProps
• setGridRowProps
• setGridViewProps
• setImageProps
• setLineEditProps
• setMenuBarProps
• setMenuProps
• setPlainTextEditProps
• setProgressBarProps
• setRadioButtonProps
• setScrollAreaProps
• setSliderProps
• setSpinBoxProps
• setSystemTrayIconProps
• setWindowProps
• updateDisplacedChildren
• useEventHandler

Object literals

• defaultOptions

Type aliases

Allowed

Ƭ Allowed: OnlyType‹TItem, SetParentFunc‹TParent››

---

ComboBoxItem

Ƭ ComboBoxItem: object

Type declaration:

• icon? : QIcon

• text: string

• userData? : QVariant

---

Geometry

Ƭ Geometry: object

Type declaration:

• height: number

• width: number

• x: number

• y: number

---

GridColumnProps

Ƭ GridColumnProps: object

Type declaration:

• width? : undefined | number

---

GridRowProps

Ƭ GridRowProps: object

Type declaration:

• children: Array‹FunctionComponentElement‹GridColumnProps›› | FunctionComponentElement‹GridColumnProps›

• height? : undefined | number

---

GridViewColumnProps

Ƭ GridViewColumnProps: object

Type declaration:

• [ ColumnIndex: number]: object

• minWidth? : undefined | number

• stretch? : undefined | number

---

GridViewRowProps

Ƭ GridViewRowProps: object

Type declaration:

• [ RowIndex: number]: object

• minHeight? : undefined | number

• stretch? : undefined | number

---

KeysOfType

Ƭ KeysOfType: object[keyof T]

Extract the keys of type T matching type TType

---

NodeGuiReconciler

Ƭ NodeGuiReconciler: Reconciler‹RNComponent, any, Set‹NodeWidget‹any››, any›

---

OnlyType

Ƭ OnlyType: object

Show TypeScript that the fields we're interested in are of type TType

Type declaration:

---

Position

Ƭ Position: object

Type declaration:

• x: number

• y: number

---

Range

Ƭ Range: object

Type declaration:

• maximum: number

• minimum: number

---

RendererOptions

Ƭ RendererOptions: object

Type declaration:

• onInit? : undefined | function

• onRender? : undefined | function

---

SetParentFunc

Ƭ SetParentFunc: function

Type declaration:

▸ (parent: T, index: number): void

Parameters:

Name	Type
parent	T
index	number

---

Size

Ƭ Size: object

Type declaration:

• height: number

• width: number

---

ViewSize

Ƭ ViewSize: Size & object

---

WidgetAttributesMap

Ƭ WidgetAttributesMap: object

Type declaration:

• [ key: number]: boolean

---

WidgetEventListeners

Ƭ WidgetEventListeners: object

Type declaration:

---

WindowFlagsMap

Ƭ WindowFlagsMap: object

Type declaration:

• [ key: number]: boolean

Variables

Let appProxy

• appProxy: ReactProxyComponent

Functions

Const App

▸ App(): Element‹›

Returns: Element‹›

---

getLoadedPixmap

▸ getLoadedPixmap(imageUrlOrPath: string): Promise‹QPixmap›

Parameters:

Name	Type
imageUrlOrPath	string

Returns: Promise‹QPixmap›

---

getLoadedQMovie

▸ getLoadedQMovie(imageUrlOrPath: string): Promise‹QMovie›

Parameters:

Name	Type
imageUrlOrPath	string

Returns: Promise‹QMovie›

---

hot

▸ hot(Component: React.ComponentType): React.ComponentType

Parameters:

Name	Type
Component	React.ComponentType

Returns: React.ComponentType

---

Const offsetForIndex

▸ offsetForIndex‹T›(index: number, items: Array‹DataWithOffset‹OnlyType‹T, number›››, sizeKey: keyof OnlyType<T, number>): number

Type parameters:

▪ T

Parameters:

Name	Type
index	number
items	Array‹DataWithOffset‹OnlyType‹T, number›››
sizeKey	keyof OnlyType<T, number>

Returns: number

---

setAbstractButtonProps

▸ setAbstractButtonProps‹Signals›(widget: QAbstractButton‹Signals›, newProps: AbstractButtonProps‹Signals›, oldProps: AbstractButtonProps‹Signals›): void

Type parameters:

▪ Signals: QAbstractButtonSignals

Parameters:

Name	Type
widget	QAbstractButton‹Signals›
newProps	AbstractButtonProps‹Signals›
oldProps	AbstractButtonProps‹Signals›

Returns: void

---

Const setActionProps

▸ setActionProps(widget: RNAction, newProps: ActionProps, oldProps: ActionProps): void

Parameters:

Name	Type
widget	RNAction
newProps	ActionProps
oldProps	ActionProps

Returns: void

---

Const setAnimatedImageProps

▸ setAnimatedImageProps(widget: RNAnimatedImage, newProps: AnimatedImageProps, oldProps: AnimatedImageProps): void

Parameters:

Name	Type
widget	RNAnimatedImage
newProps	AnimatedImageProps
oldProps	AnimatedImageProps

Returns: void

---

Const setBoxViewProps

▸ setBoxViewProps(widget: RNBoxView, newProps: BoxViewProps, oldProps: BoxViewProps): void

Parameters:

Name	Type
widget	RNBoxView
newProps	BoxViewProps
oldProps	BoxViewProps

Returns: void

---

Const setButtonProps

▸ setButtonProps(widget: RNButton, newProps: ButtonProps, oldProps: ButtonProps): void

Parameters:

Name	Type
widget	RNButton
newProps	ButtonProps
oldProps	ButtonProps

Returns: void

---

Const setCheckBoxProps

▸ setCheckBoxProps(widget: RNCheckBox, newProps: CheckBoxProps, oldProps: CheckBoxProps): void

Parameters:

Name	Type
widget	RNCheckBox
newProps	CheckBoxProps
oldProps	CheckBoxProps

Returns: void

---

Const setComboBoxProps

▸ setComboBoxProps(widget: RNComboBox, newProps: ComboBoxProps, oldProps: ComboBoxProps): void

Parameters:

Name	Type
widget	RNComboBox
newProps	ComboBoxProps
oldProps	ComboBoxProps

Returns: void

---

Const setDialProps

▸ setDialProps(widget: RNDial, newProps: DialProps, oldProps: DialProps): void

Parameters:

Name	Type
widget	RNDial
newProps	DialProps
oldProps	DialProps

Returns: void

---

Const setGridColumnProps

▸ setGridColumnProps(widget: RNGridColumn, parentRow: RNGridRow, newProps: GridColumnProps, oldProps: GridColumnProps): void

Parameters:

Name	Type
widget	RNGridColumn
parentRow	RNGridRow
newProps	GridColumnProps
oldProps	GridColumnProps

Returns: void

---

Const setGridRowProps

▸ setGridRowProps(widget: RNGridRow, parentGrid: RNGridView, newProps: Omit‹GridRowProps, "children"›, oldProps: Omit‹GridRowProps, "children"›): void

Parameters:

Name	Type
widget	RNGridRow
parentGrid	RNGridView
newProps	Omit‹GridRowProps, "children"›
oldProps	Omit‹GridRowProps, "children"›

Returns: void

---

Const setGridViewProps

▸ setGridViewProps(widget: RNGridView, newProps: Omit‹GridViewProps, "children"›, oldProps: Omit‹GridViewProps, "children"›): void

Parameters:

Name	Type
widget	RNGridView
newProps	Omit‹GridViewProps, "children"›
oldProps	Omit‹GridViewProps, "children"›

Returns: void

---

Const setImageProps

▸ setImageProps(widget: RNImage, newProps: ImageProps, oldProps: ImageProps): void

Parameters:

Name	Type
widget	RNImage
newProps	ImageProps
oldProps	ImageProps

Returns: void

---

Const setLineEditProps

▸ setLineEditProps(widget: RNLineEdit, newProps: LineEditProps, oldProps: LineEditProps): void

Parameters:

Name	Type
widget	RNLineEdit
newProps	LineEditProps
oldProps	LineEditProps

Returns: void

---

Const setMenuBarProps

▸ setMenuBarProps(widget: RNMenuBar, newProps: MenuBarProps, oldProps: MenuBarProps): void

Parameters:

Name	Type
widget	RNMenuBar
newProps	MenuBarProps
oldProps	MenuBarProps

Returns: void

---

Const setMenuProps

▸ setMenuProps(widget: RNMenu, newProps: MenuProps, oldProps: MenuProps): void

Parameters:

Name	Type
widget	RNMenu
newProps	MenuProps
oldProps	MenuProps

Returns: void

---

Const setPlainTextEditProps

▸ setPlainTextEditProps(widget: RNPlainTextEdit, newProps: PlainTextEditProps, oldProps: PlainTextEditProps): void

Parameters:

Name	Type
widget	RNPlainTextEdit
newProps	PlainTextEditProps
oldProps	PlainTextEditProps

Returns: void

---

Const setProgressBarProps

▸ setProgressBarProps(widget: RNProgressBar, newProps: ProgressBarProps, oldProps: ProgressBarProps): void

Parameters:

Name	Type
widget	RNProgressBar
newProps	ProgressBarProps
oldProps	ProgressBarProps

Returns: void

---

Const setRadioButtonProps

▸ setRadioButtonProps(widget: RNRadioButton, newProps: RadioButtonProps, oldProps: RadioButtonProps): void

Parameters:

Name	Type
widget	RNRadioButton
newProps	RadioButtonProps
oldProps	RadioButtonProps

Returns: void

---

Const setScrollAreaProps

▸ setScrollAreaProps(widget: RNScrollArea, newProps: ScrollAreaProps, oldProps: ScrollAreaProps): void

Parameters:

Name	Type
widget	RNScrollArea
newProps	ScrollAreaProps
oldProps	ScrollAreaProps

Returns: void

---

Const setSliderProps

▸ setSliderProps(widget: RNSlider, newProps: SliderProps, oldProps: SliderProps): void

Parameters:

Name	Type
widget	RNSlider
newProps	SliderProps
oldProps	SliderProps

Returns: void

---

Const setSpinBoxProps

▸ setSpinBoxProps(widget: RNSpinBox, newProps: SpinBoxProps, oldProps: SpinBoxProps): void

Parameters:

Name	Type
widget	RNSpinBox
newProps	SpinBoxProps
oldProps	SpinBoxProps

Returns: void

---

Const setSystemTrayIconProps

▸ setSystemTrayIconProps(widget: RNSystemTrayIcon, newProps: SystemTrayIconProps, oldProps: SystemTrayIconProps): void

Parameters:

Name	Type
widget	RNSystemTrayIcon
newProps	SystemTrayIconProps
oldProps	SystemTrayIconProps

Returns: void

---

Const setWindowProps

▸ setWindowProps(window: RNWindow, newProps: WindowProps, oldProps: WindowProps): void

Parameters:

Name	Type
window	RNWindow
newProps	WindowProps
oldProps	WindowProps

Returns: void

---

updateDisplacedChildren

▸ updateDisplacedChildren‹TItem, TParent›(startIndex: number, items: Array‹DataWithOffset‹OnlyType‹TItem, number› & Allowed‹TItem, TParent›››, parent: TParent, sizeKey: keyof OnlyType<TItem, number>, setParentFuncKey: keyof Allowed<TItem, TParent>): void

Type parameters:

▪ TItem

▪ TParent

Parameters:

Name	Type
startIndex	number
items	Array‹DataWithOffset‹OnlyType‹TItem, number› & Allowed‹TItem, TParent›››
parent	TParent
sizeKey	keyof OnlyType<TItem, number>
setParentFuncKey	keyof Allowed<TItem, TParent>

Returns: void

---

useEventHandler

▸ useEventHandler‹Signals›(eventHandlerMap: Partial‹WidgetEventListeners | Signals›, deps: DependencyList): object | object

Type parameters:

▪ Signals

Parameters:

Name	Type
eventHandlerMap	Partial‹WidgetEventListeners | Signals›
deps	DependencyList

Returns: object | object

Object literals

Const defaultOptions

▪ defaultOptions: object

onInit

▸ onInit(): void

Returns: void

onRender

▸ onRender(): void

Returns: void