@nodegui/react-nodegui

Index

Modules

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

Allowed

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


CellPosition

Ƭ CellPosition: []


ComboBoxItem

Ƭ ComboBoxItem: object

Type declaration:

  • icon? : QIcon

  • text: string

  • userData? : QVariant


CustomTableProps

Ƭ CustomTableProps: Omit‹TableProps, "cellRange"›


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:

NameType
parentT
indexnumber

SimplifiedTableItemProps

Ƭ SimplifiedTableItemProps: Omit‹TableItemProps, "cellPosition"›


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


Const styleSheet

• styleSheet: " #container { flex: 1; min-height: '100%'; justify-content: 'center'; } #textContainer { flex-direction: 'row'; justify-content: 'space-around'; align-items: 'center'; } " = #container { flex: 1; min-height: '100%'; justify-content: 'center'; } #textContainer { flex-direction: 'row'; justify-content: 'space-around'; align-items: 'center'; }

Functions

Const App

▸ App(): Element‹›

Returns: Element‹›


getLoadedPixmap

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

Parameters:

NameType
imageUrlOrPathstring

Returns: Promise‹QPixmap›


getLoadedQMovie

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

Parameters:

NameType
imageUrlOrPathstring

Returns: Promise‹QMovie›


hot

â–¸ hot(Component: React.ComponentType): React.ComponentType

Parameters:

NameType
ComponentReact.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:

NameType
indexnumber
itemsArray‹DataWithOffset‹OnlyType‹T, number›››
sizeKeykeyof OnlyType<T, number>

Returns: number


setAbstractButtonProps

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

Type parameters:

â–ª Signals: QAbstractButtonSignals

Parameters:

NameType
widgetQAbstractButton‹Signals›
newPropsAbstractButtonProps‹Signals›
oldPropsAbstractButtonProps‹Signals›

Returns: void


Const setActionProps

â–¸ setActionProps(widget: RNAction, newProps: ActionProps, oldProps: ActionProps): void

Parameters:

NameType
widgetRNAction
newPropsActionProps
oldPropsActionProps

Returns: void


Const setAnimatedImageProps

â–¸ setAnimatedImageProps(widget: RNAnimatedImage, newProps: AnimatedImageProps, oldProps: AnimatedImageProps): void

Parameters:

NameType
widgetRNAnimatedImage
newPropsAnimatedImageProps
oldPropsAnimatedImageProps

Returns: void


Const setBoxViewProps

â–¸ setBoxViewProps(widget: RNBoxView, newProps: BoxViewProps, oldProps: BoxViewProps): void

Parameters:

NameType
widgetRNBoxView
newPropsBoxViewProps
oldPropsBoxViewProps

Returns: void


Const setButtonProps

â–¸ setButtonProps(widget: RNButton, newProps: ButtonProps, oldProps: ButtonProps): void

Parameters:

NameType
widgetRNButton
newPropsButtonProps
oldPropsButtonProps

Returns: void


Const setCheckBoxProps

â–¸ setCheckBoxProps(widget: RNCheckBox, newProps: CheckBoxProps, oldProps: CheckBoxProps): void

Parameters:

NameType
widgetRNCheckBox
newPropsCheckBoxProps
oldPropsCheckBoxProps

Returns: void


setColorDialogProps

â–¸ setColorDialogProps(widget: RNColorDialog, newProps: ColorDialogProps, oldProps: ColorDialogProps): void

Parameters:

NameType
widgetRNColorDialog
newPropsColorDialogProps
oldPropsColorDialogProps

Returns: void


Const setComboBoxProps

â–¸ setComboBoxProps(widget: RNComboBox, newProps: ComboBoxProps, oldProps: ComboBoxProps): void

Parameters:

NameType
widgetRNComboBox
newPropsComboBoxProps
oldPropsComboBoxProps

Returns: void


Const setDialProps

â–¸ setDialProps(widget: RNDial, newProps: DialProps, oldProps: DialProps): void

Parameters:

NameType
widgetRNDial
newPropsDialProps
oldPropsDialProps

Returns: void


setDialogProps

â–¸ setDialogProps(widget: RNDialog, newProps: DialogProps, oldProps: DialogProps): void

Parameters:

NameType
widgetRNDialog
newPropsDialogProps
oldPropsDialogProps

Returns: void


setErrorPromptProps

â–¸ setErrorPromptProps(widget: RNErrorPrompt, newProps: ErrorPromptProps, oldProps: ErrorPromptProps): void

Parameters:

NameType
widgetRNErrorPrompt
newPropsErrorPromptProps
oldPropsErrorPromptProps

Returns: void


setFileDialogProps

â–¸ setFileDialogProps(widget: RNFileDialog, newProps: FileDialogProps, oldProps: FileDialogProps): void

Parameters:

NameType
widgetRNFileDialog
newPropsFileDialogProps
oldPropsFileDialogProps

Returns: void


setFontDialogProps

â–¸ setFontDialogProps(widget: RNFontDialog, newProps: FontDialogProps, oldProps: FontDialogProps): void

Parameters:

NameType
widgetRNFontDialog
newPropsFontDialogProps
oldPropsFontDialogProps

Returns: void


Const setGridColumnProps

â–¸ setGridColumnProps(widget: RNGridColumn, parentRow: RNGridRow, newProps: GridColumnProps, oldProps: GridColumnProps): void

Parameters:

NameType
widgetRNGridColumn
parentRowRNGridRow
newPropsGridColumnProps
oldPropsGridColumnProps

Returns: void


Const setGridRowProps

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

Parameters:

NameType
widgetRNGridRow
parentGridRNGridView
newPropsOmit‹GridRowProps, "children"›
oldPropsOmit‹GridRowProps, "children"›

Returns: void


Const setGridViewProps

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

Parameters:

NameType
widgetRNGridView
newPropsOmit‹GridViewProps, "children"›
oldPropsOmit‹GridViewProps, "children"›

Returns: void


Const setImageProps

â–¸ setImageProps(widget: RNImage, newProps: ImageProps, oldProps: ImageProps): void

Parameters:

NameType
widgetRNImage
newPropsImageProps
oldPropsImageProps

Returns: void


setInputDialogProps

â–¸ setInputDialogProps(widget: RNInputDialog, newProps: InputDialogProps, oldProps: InputDialogProps): void

Parameters:

NameType
widgetRNInputDialog
newPropsInputDialogProps
oldPropsInputDialogProps

Returns: void


Const setLineEditProps

â–¸ setLineEditProps(widget: RNLineEdit, newProps: LineEditProps, oldProps: LineEditProps): void

Parameters:

NameType
widgetRNLineEdit
newPropsLineEditProps
oldPropsLineEditProps

Returns: void


Const setMenuBarProps

â–¸ setMenuBarProps(widget: RNMenuBar, newProps: MenuBarProps, oldProps: MenuBarProps): void

Parameters:

NameType
widgetRNMenuBar
newPropsMenuBarProps
oldPropsMenuBarProps

Returns: void


Const setMenuProps

â–¸ setMenuProps(widget: RNMenu, newProps: MenuProps, oldProps: MenuProps): void

Parameters:

NameType
widgetRNMenu
newPropsMenuProps
oldPropsMenuProps

Returns: void


Const setPlainTextEditProps

â–¸ setPlainTextEditProps(widget: RNPlainTextEdit, newProps: PlainTextEditProps, oldProps: PlainTextEditProps): void

Parameters:

NameType
widgetRNPlainTextEdit
newPropsPlainTextEditProps
oldPropsPlainTextEditProps

Returns: void


Const setProgressBarProps

â–¸ setProgressBarProps(widget: RNProgressBar, newProps: ProgressBarProps, oldProps: ProgressBarProps): void

Parameters:

NameType
widgetRNProgressBar
newPropsProgressBarProps
oldPropsProgressBarProps

Returns: void


setProgressDialogProps

â–¸ setProgressDialogProps(widget: RNProgressDialog, newProps: ProgressDialogProps, oldProps: ProgressDialogProps): void

Parameters:

NameType
widgetRNProgressDialog
newPropsProgressDialogProps
oldPropsProgressDialogProps

Returns: void


Const setRadioButtonProps

â–¸ setRadioButtonProps(widget: RNRadioButton, newProps: RadioButtonProps, oldProps: RadioButtonProps): void

Parameters:

NameType
widgetRNRadioButton
newPropsRadioButtonProps
oldPropsRadioButtonProps

Returns: void


Const setScrollAreaProps

â–¸ setScrollAreaProps(widget: RNScrollArea, newProps: ScrollAreaProps, oldProps: ScrollAreaProps): void

Parameters:

NameType
widgetRNScrollArea
newPropsScrollAreaProps
oldPropsScrollAreaProps

Returns: void


Const setSliderProps

â–¸ setSliderProps(widget: RNSlider, newProps: SliderProps, oldProps: SliderProps): void

Parameters:

NameType
widgetRNSlider
newPropsSliderProps
oldPropsSliderProps

Returns: void


Const setSpinBoxProps

â–¸ setSpinBoxProps(widget: RNSpinBox, newProps: SpinBoxProps, oldProps: SpinBoxProps): void

Parameters:

NameType
widgetRNSpinBox
newPropsSpinBoxProps
oldPropsSpinBoxProps

Returns: void


Const setSystemTrayIconProps

â–¸ setSystemTrayIconProps(widget: RNSystemTrayIcon, newProps: SystemTrayIconProps, oldProps: SystemTrayIconProps): void

Parameters:

NameType
widgetRNSystemTrayIcon
newPropsSystemTrayIconProps
oldPropsSystemTrayIconProps

Returns: void


Const setTableItemProps

â–¸ setTableItemProps(widget: RNTableItem, newProps: SimplifiedTableItemProps, oldProps: SimplifiedTableItemProps): void

Parameters:

NameType
widgetRNTableItem
newPropsSimplifiedTableItemProps
oldPropsSimplifiedTableItemProps

Returns: void


Const setWindowProps

â–¸ setWindowProps(window: RNWindow, newProps: WindowProps, oldProps: WindowProps): void

Parameters:

NameType
windowRNWindow
newPropsWindowProps
oldPropsWindowProps

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:

NameType
startIndexnumber
itemsArray‹DataWithOffset‹OnlyType‹TItem, number› & Allowed‹TItem, TParent›››
parentTParent
sizeKeykeyof OnlyType<TItem, number>
setParentFuncKeykeyof Allowed<TItem, TParent>

Returns: void


useEventHandler

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

Type parameters:

â–ª Signals

Parameters:

NameType
eventHandlerMapPartial‹WidgetEventListeners | Signals›
depsDependencyList

Returns: object | object


verifyRanges

â–¸ verifyRanges(__namedParameters: object, __namedParameters: object): void

Parameters:

â–ª __namedParameters: object

NameType
columnCountnumber
rowCountnumber

â–ª __namedParameters: object

NameType
columnundefined | number
rowundefined | number

Returns: void

Object literals

Const defaultOptions

â–ª defaultOptions: object

onInit

â–¸ onInit(): void

Returns: void

onRender

â–¸ onRender(): void

Returns: void