diff --git a/package.json b/package.json index b99a915ed..b769c2a76 100644 --- a/package.json +++ b/package.json @@ -15,7 +15,7 @@ "test": "qode ./node_modules/jest/bin/jest -i", "lint:cpp": "clang-format -i --glob=src/cpp/**/*.[h,c]*", "lint:ts": "tsc --noEmit && cross-env eslint './src/**/*.{ts,tsx,js,jsx}' --fix", - "docs": "typedoc && mv ./website/website/sidebars.js ./website/docs/api/sidebar-gen.js" + "docs": "typedoc && mv ./website/website/sidebars.js ./website/docs/api/sidebar-gen.js && rm -rf website/docs/api/generated/index.md" }, "dependencies": { "@nodegui/qode": "^1.0.6", diff --git a/src/lib/core/Component.ts b/src/lib/core/Component.ts index dcbf4a15b..7d6b49c83 100644 --- a/src/lib/core/Component.ts +++ b/src/lib/core/Component.ts @@ -16,8 +16,11 @@ Its the root base class in NodeGui world. */ export abstract class Component { - nodeChildren = new Set(); + nodeChildren: Set; nodeParent?: Component; + constructor() { + this.nodeChildren = new Set(); + } setNodeParent(parent?: Component): void { this.nodeParent = parent; parent?.nodeChildren.add(this); diff --git a/website/docs/api/generated/classes/component.md b/website/docs/api/generated/classes/component.md index c85bce71b..934bdc10f 100644 --- a/website/docs/api/generated/classes/component.md +++ b/website/docs/api/generated/classes/component.md @@ -57,6 +57,10 @@ Its the root base class in NodeGui world. ## Index +### Constructors + +* [constructor](component.md#constructor) + ### Properties * [native](component.md#abstract-native) @@ -67,6 +71,14 @@ Its the root base class in NodeGui world. * [setNodeParent](component.md#setnodeparent) +## Constructors + +### constructor + +\+ **new Component**(): *[Component](component.md)* + +**Returns:** *[Component](component.md)* + ## Properties ### `Abstract` native @@ -77,7 +89,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* ___ diff --git a/website/docs/api/generated/classes/eventwidget.md b/website/docs/api/generated/classes/eventwidget.md index 8bbef6e99..f2c6f285b 100644 --- a/website/docs/api/generated/classes/eventwidget.md +++ b/website/docs/api/generated/classes/eventwidget.md @@ -64,6 +64,8 @@ console.log("mouse moved"); \+ **new EventWidget**(`native`: [NativeElement](../globals.md#nativeelement)): *[EventWidget](eventwidget.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -84,7 +86,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/flexlayout.md b/website/docs/api/generated/classes/flexlayout.md index 680ccb346..d1cc6e2ae 100644 --- a/website/docs/api/generated/classes/flexlayout.md +++ b/website/docs/api/generated/classes/flexlayout.md @@ -99,7 +99,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/nodelayout.md b/website/docs/api/generated/classes/nodelayout.md index dd60c196d..5582fbe0d 100644 --- a/website/docs/api/generated/classes/nodelayout.md +++ b/website/docs/api/generated/classes/nodelayout.md @@ -84,6 +84,8 @@ addChildToLayout(new GridLayout(), new QWidget()); *Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -104,7 +106,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/nodeobject.md b/website/docs/api/generated/classes/nodeobject.md index a1b959aa6..072cdcfb9 100644 --- a/website/docs/api/generated/classes/nodeobject.md +++ b/website/docs/api/generated/classes/nodeobject.md @@ -59,6 +59,8 @@ sidebar_label: "NodeObject" *Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -79,7 +81,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/nodewidget.md b/website/docs/api/generated/classes/nodewidget.md index 9706b7c16..b92b16c2f 100644 --- a/website/docs/api/generated/classes/nodewidget.md +++ b/website/docs/api/generated/classes/nodewidget.md @@ -156,6 +156,8 @@ Implement all native QWidget methods here so that all widgets get access to thos *Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -188,7 +190,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qabstractbutton.md b/website/docs/api/generated/classes/qabstractbutton.md index d3e5f74b8..91bd63ecc 100644 --- a/website/docs/api/generated/classes/qabstractbutton.md +++ b/website/docs/api/generated/classes/qabstractbutton.md @@ -106,6 +106,8 @@ sidebar_label: "QAbstractButton" *Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -142,7 +144,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qabstractscrollarea.md b/website/docs/api/generated/classes/qabstractscrollarea.md index d93167815..f32d4d730 100644 --- a/website/docs/api/generated/classes/qabstractscrollarea.md +++ b/website/docs/api/generated/classes/qabstractscrollarea.md @@ -117,6 +117,8 @@ QAbstractScrollArea will list all methods and properties that are common to all *Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -153,7 +155,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qabstractslider.md b/website/docs/api/generated/classes/qabstractslider.md index b8da457ca..3c642bffe 100644 --- a/website/docs/api/generated/classes/qabstractslider.md +++ b/website/docs/api/generated/classes/qabstractslider.md @@ -114,6 +114,8 @@ QAbstractSlider will list all methods and properties that are common to all slid *Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -150,7 +152,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qaction.md b/website/docs/api/generated/classes/qaction.md index 154cd14f6..2fc68f375 100644 --- a/website/docs/api/generated/classes/qaction.md +++ b/website/docs/api/generated/classes/qaction.md @@ -55,6 +55,7 @@ menu.addAction(menuAction); * [setCheckable](qaction.md#setcheckable) * [setChecked](qaction.md#setchecked) * [setEnabled](qaction.md#setenabled) +* [setFont](qaction.md#setfont) * [setIcon](qaction.md#seticon) * [setMenu](qaction.md#setmenu) * [setNodeParent](qaction.md#setnodeparent) @@ -123,7 +124,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* @@ -342,6 +343,23 @@ Name | Type | ___ +### setFont + +▸ **setFont**(`family`: string, `pointSize`: number, `weight`: number, `italic`: boolean): *void* + +**Parameters:** + +Name | Type | Default | +------ | ------ | ------ | +`family` | string | - | +`pointSize` | number | -1 | +`weight` | number | -1 | +`italic` | boolean | false | + +**Returns:** *void* + +___ + ### setIcon ▸ **setIcon**(`icon`: [QIcon](qicon.md)): *void* diff --git a/website/docs/api/generated/classes/qapplication.md b/website/docs/api/generated/classes/qapplication.md index d469db5de..89c802da2 100644 --- a/website/docs/api/generated/classes/qapplication.md +++ b/website/docs/api/generated/classes/qapplication.md @@ -56,10 +56,14 @@ qApp.quit(); \+ **new QApplication**(): *[QApplication](qapplication.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QApplication](qapplication.md)* \+ **new QApplication**(`native`: [NativeElement](../globals.md#nativeelement)): *[QApplication](qapplication.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -80,7 +84,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qboxlayout.md b/website/docs/api/generated/classes/qboxlayout.md index 58bcb9f69..e72f31106 100644 --- a/website/docs/api/generated/classes/qboxlayout.md +++ b/website/docs/api/generated/classes/qboxlayout.md @@ -95,7 +95,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qcheckbox.md b/website/docs/api/generated/classes/qcheckbox.md index 6d8742c18..f798b6087 100644 --- a/website/docs/api/generated/classes/qcheckbox.md +++ b/website/docs/api/generated/classes/qcheckbox.md @@ -153,7 +153,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qclipboard.md b/website/docs/api/generated/classes/qclipboard.md index e2e8f1161..0a5bf84ef 100644 --- a/website/docs/api/generated/classes/qclipboard.md +++ b/website/docs/api/generated/classes/qclipboard.md @@ -52,6 +52,8 @@ const text = clipboard.text(QClipboardMode.Clipboard); \+ **new QClipboard**(`native`: [NativeElement](../globals.md#nativeelement)): *[QClipboard](qclipboard.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -72,7 +74,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qcolor.md b/website/docs/api/generated/classes/qcolor.md index ff1c469a1..4407d67f4 100644 --- a/website/docs/api/generated/classes/qcolor.md +++ b/website/docs/api/generated/classes/qcolor.md @@ -41,10 +41,14 @@ sidebar_label: "QColor" \+ **new QColor**(): *[QColor](qcolor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QColor](qcolor.md)* \+ **new QColor**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QColor](qcolor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -55,6 +59,8 @@ Name | Type | \+ **new QColor**(`colorString`: string): *[QColor](qcolor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -65,6 +71,8 @@ Name | Type | \+ **new QColor**(`color`: [GlobalColor](../enums/globalcolor.md)): *[QColor](qcolor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -75,6 +83,8 @@ Name | Type | \+ **new QColor**(`r?`: undefined | number, `g?`: undefined | number, `b?`: undefined | number, `a?`: undefined | number): *[QColor](qcolor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -98,7 +108,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qcombobox.md b/website/docs/api/generated/classes/qcombobox.md index 2f4e9c634..a6d3a60bf 100644 --- a/website/docs/api/generated/classes/qcombobox.md +++ b/website/docs/api/generated/classes/qcombobox.md @@ -151,7 +151,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qcursor.md b/website/docs/api/generated/classes/qcursor.md index f94123f4b..99ec03748 100644 --- a/website/docs/api/generated/classes/qcursor.md +++ b/website/docs/api/generated/classes/qcursor.md @@ -46,10 +46,14 @@ const cursor = new QCursor(); \+ **new QCursor**(): *[QCursor](qcursor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QCursor](qcursor.md)* \+ **new QCursor**(`native`: [NativeElement](../globals.md#nativeelement)): *[QCursor](qcursor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -60,6 +64,8 @@ Name | Type | \+ **new QCursor**(`shape`: [CursorShape](../enums/cursorshape.md)): *[QCursor](qcursor.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -80,7 +86,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qdial.md b/website/docs/api/generated/classes/qdial.md index 86bf265c9..0589e085b 100644 --- a/website/docs/api/generated/classes/qdial.md +++ b/website/docs/api/generated/classes/qdial.md @@ -160,7 +160,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qfiledialog.md b/website/docs/api/generated/classes/qfiledialog.md index 7a7815802..b817b7a62 100644 --- a/website/docs/api/generated/classes/qfiledialog.md +++ b/website/docs/api/generated/classes/qfiledialog.md @@ -150,7 +150,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qfontdatabase.md b/website/docs/api/generated/classes/qfontdatabase.md index a289c6d7a..f8120b911 100644 --- a/website/docs/api/generated/classes/qfontdatabase.md +++ b/website/docs/api/generated/classes/qfontdatabase.md @@ -37,6 +37,8 @@ sidebar_label: "QFontDatabase" \+ **new QFontDatabase**(): *[QFontDatabase](qfontdatabase.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QFontDatabase](qfontdatabase.md)* ## Properties @@ -51,7 +53,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qgridlayout.md b/website/docs/api/generated/classes/qgridlayout.md index 0bf170389..accf17b6e 100644 --- a/website/docs/api/generated/classes/qgridlayout.md +++ b/website/docs/api/generated/classes/qgridlayout.md @@ -95,7 +95,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qgroupbox.md b/website/docs/api/generated/classes/qgroupbox.md index 803f82f81..d9fb44447 100644 --- a/website/docs/api/generated/classes/qgroupbox.md +++ b/website/docs/api/generated/classes/qgroupbox.md @@ -142,7 +142,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qicon.md b/website/docs/api/generated/classes/qicon.md index 58f0f4fcb..46ea86c3d 100644 --- a/website/docs/api/generated/classes/qicon.md +++ b/website/docs/api/generated/classes/qicon.md @@ -50,10 +50,14 @@ const icon = new QIcon(imageUrl); \+ **new QIcon**(): *[QIcon](qicon.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QIcon](qicon.md)* \+ **new QIcon**(`native`: [NativeElement](../globals.md#nativeelement)): *[QIcon](qicon.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -64,6 +68,8 @@ Name | Type | \+ **new QIcon**(`filePath`: string): *[QIcon](qicon.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -84,7 +90,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qkeysequence.md b/website/docs/api/generated/classes/qkeysequence.md index 12a881711..65dfe9867 100644 --- a/website/docs/api/generated/classes/qkeysequence.md +++ b/website/docs/api/generated/classes/qkeysequence.md @@ -45,10 +45,14 @@ const keySequence = new QKeySequence(`Ctrl+L`); \+ **new QKeySequence**(): *[QKeySequence](qkeysequence.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QKeySequence](qkeysequence.md)* \+ **new QKeySequence**(`keySequence`: string): *[QKeySequence](qkeysequence.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -69,7 +73,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qlabel.md b/website/docs/api/generated/classes/qlabel.md index d926b8bb5..a09bcfae7 100644 --- a/website/docs/api/generated/classes/qlabel.md +++ b/website/docs/api/generated/classes/qlabel.md @@ -166,7 +166,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qlineedit.md b/website/docs/api/generated/classes/qlineedit.md index 31fa2468d..d5e312fb7 100644 --- a/website/docs/api/generated/classes/qlineedit.md +++ b/website/docs/api/generated/classes/qlineedit.md @@ -154,7 +154,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qmainwindow.md b/website/docs/api/generated/classes/qmainwindow.md index 6dddff128..63ab47f6e 100644 --- a/website/docs/api/generated/classes/qmainwindow.md +++ b/website/docs/api/generated/classes/qmainwindow.md @@ -164,7 +164,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qmenu.md b/website/docs/api/generated/classes/qmenu.md index 1fe5ada7a..1364967ac 100644 --- a/website/docs/api/generated/classes/qmenu.md +++ b/website/docs/api/generated/classes/qmenu.md @@ -153,7 +153,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qmenubar.md b/website/docs/api/generated/classes/qmenubar.md index 86a0a4f94..7e3092aa4 100644 --- a/website/docs/api/generated/classes/qmenubar.md +++ b/website/docs/api/generated/classes/qmenubar.md @@ -162,7 +162,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qmovie.md b/website/docs/api/generated/classes/qmovie.md index 7921f8118..86bd9c885 100644 --- a/website/docs/api/generated/classes/qmovie.md +++ b/website/docs/api/generated/classes/qmovie.md @@ -95,7 +95,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qobject.md b/website/docs/api/generated/classes/qobject.md index b6c478da1..078917202 100644 --- a/website/docs/api/generated/classes/qobject.md +++ b/website/docs/api/generated/classes/qobject.md @@ -79,7 +79,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qpainter.md b/website/docs/api/generated/classes/qpainter.md index 45a867e16..2a6f2b5b3 100644 --- a/website/docs/api/generated/classes/qpainter.md +++ b/website/docs/api/generated/classes/qpainter.md @@ -45,10 +45,14 @@ sidebar_label: "QPainter" \+ **new QPainter**(): *[QPainter](qpainter.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QPainter](qpainter.md)* \+ **new QPainter**(`device`: [Component](component.md)): *[QPainter](qpainter.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -69,7 +73,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qpixmap.md b/website/docs/api/generated/classes/qpixmap.md index 36b31a006..7583cf57c 100644 --- a/website/docs/api/generated/classes/qpixmap.md +++ b/website/docs/api/generated/classes/qpixmap.md @@ -54,10 +54,14 @@ const pixMap = new QPixmap(imageUrl); \+ **new QPixmap**(): *[QPixmap](qpixmap.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QPixmap](qpixmap.md)* \+ **new QPixmap**(`native`: [NativeElement](../globals.md#nativeelement)): *[QPixmap](qpixmap.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -68,6 +72,8 @@ Name | Type | \+ **new QPixmap**(`filePath`: string): *[QPixmap](qpixmap.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -88,7 +94,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qplaintextedit.md b/website/docs/api/generated/classes/qplaintextedit.md index 017cdbf4e..74849e4fe 100644 --- a/website/docs/api/generated/classes/qplaintextedit.md +++ b/website/docs/api/generated/classes/qplaintextedit.md @@ -162,7 +162,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qpoint.md b/website/docs/api/generated/classes/qpoint.md index c7b55499f..2d229aa94 100644 --- a/website/docs/api/generated/classes/qpoint.md +++ b/website/docs/api/generated/classes/qpoint.md @@ -37,10 +37,14 @@ sidebar_label: "QPoint" \+ **new QPoint**(): *[QPoint](qpoint.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QPoint](qpoint.md)* \+ **new QPoint**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QPoint](qpoint.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -51,6 +55,8 @@ Name | Type | \+ **new QPoint**(`x?`: undefined | number, `y?`: undefined | number): *[QPoint](qpoint.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -72,7 +78,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qprogressbar.md b/website/docs/api/generated/classes/qprogressbar.md index e111888fe..b3e17876a 100644 --- a/website/docs/api/generated/classes/qprogressbar.md +++ b/website/docs/api/generated/classes/qprogressbar.md @@ -151,7 +151,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qpushbutton.md b/website/docs/api/generated/classes/qpushbutton.md index f35023eb2..454f5426b 100644 --- a/website/docs/api/generated/classes/qpushbutton.md +++ b/website/docs/api/generated/classes/qpushbutton.md @@ -152,7 +152,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qradiobutton.md b/website/docs/api/generated/classes/qradiobutton.md index 280cdc995..a29df3755 100644 --- a/website/docs/api/generated/classes/qradiobutton.md +++ b/website/docs/api/generated/classes/qradiobutton.md @@ -151,7 +151,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qrect.md b/website/docs/api/generated/classes/qrect.md index 55cb7e395..7c0c07bf2 100644 --- a/website/docs/api/generated/classes/qrect.md +++ b/website/docs/api/generated/classes/qrect.md @@ -41,10 +41,14 @@ sidebar_label: "QRect" \+ **new QRect**(): *[QRect](qrect.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QRect](qrect.md)* \+ **new QRect**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QRect](qrect.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -55,6 +59,8 @@ Name | Type | \+ **new QRect**(`x?`: undefined | number, `y?`: undefined | number, `width?`: undefined | number, `height?`: undefined | number): *[QRect](qrect.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -78,7 +84,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qscrollarea.md b/website/docs/api/generated/classes/qscrollarea.md index 359891bbc..1fd71b1f9 100644 --- a/website/docs/api/generated/classes/qscrollarea.md +++ b/website/docs/api/generated/classes/qscrollarea.md @@ -169,7 +169,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qshortcut.md b/website/docs/api/generated/classes/qshortcut.md index 9012fa8e5..8da173b38 100644 --- a/website/docs/api/generated/classes/qshortcut.md +++ b/website/docs/api/generated/classes/qshortcut.md @@ -87,7 +87,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qsize.md b/website/docs/api/generated/classes/qsize.md index 8bea0e75c..668b836c9 100644 --- a/website/docs/api/generated/classes/qsize.md +++ b/website/docs/api/generated/classes/qsize.md @@ -37,10 +37,14 @@ sidebar_label: "QSize" \+ **new QSize**(): *[QSize](qsize.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QSize](qsize.md)* \+ **new QSize**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QSize](qsize.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -51,6 +55,8 @@ Name | Type | \+ **new QSize**(`width?`: undefined | number, `height?`: undefined | number): *[QSize](qsize.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -72,7 +78,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qspinbox.md b/website/docs/api/generated/classes/qspinbox.md index e03838596..68097e32a 100644 --- a/website/docs/api/generated/classes/qspinbox.md +++ b/website/docs/api/generated/classes/qspinbox.md @@ -155,7 +155,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qstackedwidget.md b/website/docs/api/generated/classes/qstackedwidget.md index 8af675417..3e010d77f 100644 --- a/website/docs/api/generated/classes/qstackedwidget.md +++ b/website/docs/api/generated/classes/qstackedwidget.md @@ -137,7 +137,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qstyle.md b/website/docs/api/generated/classes/qstyle.md index 30db726c8..c33d26feb 100644 --- a/website/docs/api/generated/classes/qstyle.md +++ b/website/docs/api/generated/classes/qstyle.md @@ -33,6 +33,8 @@ sidebar_label: "QStyle" \+ **new QStyle**(`native`: [NativeElement](../globals.md#nativeelement)): *[QStyle](qstyle.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -53,7 +55,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qsystemtrayicon.md b/website/docs/api/generated/classes/qsystemtrayicon.md index 3c3e20a61..aaa8d404d 100644 --- a/website/docs/api/generated/classes/qsystemtrayicon.md +++ b/website/docs/api/generated/classes/qsystemtrayicon.md @@ -100,7 +100,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qtablewidget.md b/website/docs/api/generated/classes/qtablewidget.md index b903f5646..7d0dd4bdb 100644 --- a/website/docs/api/generated/classes/qtablewidget.md +++ b/website/docs/api/generated/classes/qtablewidget.md @@ -186,7 +186,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qtablewidgetitem.md b/website/docs/api/generated/classes/qtablewidgetitem.md index ce4c2fe77..34622b899 100644 --- a/website/docs/api/generated/classes/qtablewidgetitem.md +++ b/website/docs/api/generated/classes/qtablewidgetitem.md @@ -38,10 +38,14 @@ sidebar_label: "QTableWidgetItem" \+ **new QTableWidgetItem**(): *[QTableWidgetItem](qtablewidgetitem.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QTableWidgetItem](qtablewidgetitem.md)* \+ **new QTableWidgetItem**(`text`: string): *[QTableWidgetItem](qtablewidgetitem.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -62,7 +66,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qtabwidget.md b/website/docs/api/generated/classes/qtabwidget.md index 8c3c9faeb..9bad23b80 100644 --- a/website/docs/api/generated/classes/qtabwidget.md +++ b/website/docs/api/generated/classes/qtabwidget.md @@ -139,7 +139,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qtoolbutton.md b/website/docs/api/generated/classes/qtoolbutton.md index ea813b073..4e66ecef3 100644 --- a/website/docs/api/generated/classes/qtoolbutton.md +++ b/website/docs/api/generated/classes/qtoolbutton.md @@ -147,7 +147,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qtreewidget.md b/website/docs/api/generated/classes/qtreewidget.md index 76c1ad3f0..e558a6e27 100644 --- a/website/docs/api/generated/classes/qtreewidget.md +++ b/website/docs/api/generated/classes/qtreewidget.md @@ -141,7 +141,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qtreewidgetitem.md b/website/docs/api/generated/classes/qtreewidgetitem.md index 08d018703..e86ef2e4c 100644 --- a/website/docs/api/generated/classes/qtreewidgetitem.md +++ b/website/docs/api/generated/classes/qtreewidgetitem.md @@ -39,10 +39,14 @@ sidebar_label: "QTreeWidgetItem" \+ **new QTreeWidgetItem**(): *[QTreeWidgetItem](qtreewidgetitem.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QTreeWidgetItem](qtreewidgetitem.md)* \+ **new QTreeWidgetItem**(`parent`: [QTreeWidgetItem](qtreewidgetitem.md), `strings?`: string[]): *[QTreeWidgetItem](qtreewidgetitem.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -54,6 +58,8 @@ Name | Type | \+ **new QTreeWidgetItem**(`parent`: [QTreeWidget](qtreewidget.md), `strings?`: string[]): *[QTreeWidgetItem](qtreewidgetitem.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -65,6 +71,8 @@ Name | Type | \+ **new QTreeWidgetItem**(`native`: [NativeElement](../globals.md#nativeelement)): *[QTreeWidgetItem](qtreewidgetitem.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -75,6 +83,8 @@ Name | Type | \+ **new QTreeWidgetItem**(`strings`: string[]): *[QTreeWidgetItem](qtreewidgetitem.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -95,7 +105,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qurl.md b/website/docs/api/generated/classes/qurl.md index 8ec7690e5..bc8538ebc 100644 --- a/website/docs/api/generated/classes/qurl.md +++ b/website/docs/api/generated/classes/qurl.md @@ -35,10 +35,14 @@ sidebar_label: "QUrl" \+ **new QUrl**(): *[QUrl](qurl.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QUrl](qurl.md)* \+ **new QUrl**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QUrl](qurl.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -49,6 +53,8 @@ Name | Type | \+ **new QUrl**(`url`: string, `parsingMode?`: [ParsingMode](../enums/parsingmode.md)): *[QUrl](qurl.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -70,7 +76,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qvariant.md b/website/docs/api/generated/classes/qvariant.md index d5356cc3b..6a1dde157 100644 --- a/website/docs/api/generated/classes/qvariant.md +++ b/website/docs/api/generated/classes/qvariant.md @@ -36,10 +36,14 @@ sidebar_label: "QVariant" \+ **new QVariant**(): *[QVariant](qvariant.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Returns:** *[QVariant](qvariant.md)* \+ **new QVariant**(`nativeElement`: [NativeElement](../globals.md#nativeelement)): *[QVariant](qvariant.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -50,6 +54,8 @@ Name | Type | \+ **new QVariant**(`variant`: [QVariantType](../globals.md#qvarianttype)): *[QVariant](qvariant.md)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -70,7 +76,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/qwidget.md b/website/docs/api/generated/classes/qwidget.md index b547eb5a3..fea6b7842 100644 --- a/website/docs/api/generated/classes/qwidget.md +++ b/website/docs/api/generated/classes/qwidget.md @@ -142,7 +142,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/classes/yogawidget.md b/website/docs/api/generated/classes/yogawidget.md index 6fdde60d8..77ad025b7 100644 --- a/website/docs/api/generated/classes/yogawidget.md +++ b/website/docs/api/generated/classes/yogawidget.md @@ -65,6 +65,8 @@ YogaWidget helps in storing all flex properties of a widget. *Inherited from [EventWidget](eventwidget.md).[constructor](eventwidget.md#constructor)* +*Overrides [Component](component.md).[constructor](component.md#constructor)* + **Parameters:** Name | Type | @@ -85,7 +87,7 @@ ___ ### nodeChildren -• **nodeChildren**: *Set‹unknown›* = new Set() +• **nodeChildren**: *Set‹[Component](component.md)›* *Inherited from [Component](component.md).[nodeChildren](component.md#nodechildren)* diff --git a/website/docs/api/generated/index.md b/website/docs/api/generated/index.md deleted file mode 100644 index 5567467ef..000000000 --- a/website/docs/api/generated/index.md +++ /dev/null @@ -1,196 +0,0 @@ ---- -id: "index" -title: "@nodegui/nodegui" -sidebar_label: "README" ---- - -# NodeGui - -[![Join the NodeGUI community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/nodegui) -[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat-square)](#contributors) -[![JS Party #96](https://img.shields.io/badge/JS%20Party-%2396-FFCD00.svg)](https://changelog.com/jsparty/96) - -[![Build and Test status](https://github.com/nodegui/nodegui/workflows/.github/workflows/test.yml/badge.svg)](https://github.com/nodegui/nodegui/actions) - -Build **performant**, **native** and **cross-platform** desktop applications with **Node.js** and **CSS like styling**.🚀 - -NodeGUI is powered by **Qt5** 💚 which makes it CPU and memory efficient as compared to other chromium based solutions like electron. - -If you are looking for **React** based version, check out: **[React NodeGUI](https://github.com/nodegui/react-nodegui)**. - -Visit: https://nodegui.github.io/nodegui for docs. - -logo - -> This project is in active development. It should be okay for smaller projects but anything complex - electron is the way to go for now. 🚧 - -## How does it look? - -
-demo_linux -demo_win -demo_mac -
- -
kitchendemo_macdemo_win -
- -**More screenshots?** - -### More Examples: - -https://github.com/nodegui/examples - ---- - -## Features - -- 🧬 Cross platform. Should work on major Linux flavours, Windows and MacOS. -- 📉 Low CPU and memory footprint. Current CPU stays at 0% on idle and memory usage is under 20mb for a hello world program. -- 💅 Styling with CSS (includes actual cascading). Also has full support for Flexbox layout (thanks to Yoga). -- ✅ Complete Nodejs api support (Currently runs on Node v12.x - and is easily upgradable). Hence has access to all nodejs compatible npm modules. -- 🎪 Native widget event listener support. Supports all events available from Qt / NodeJs. -- 💸 Can be used for Commercial applications. -- 🕵️‍♂️ Good Devtools support. -- 📚 Good documentation and website. -- 🧙‍♂️ Good documentation for contributors. -- 🦹🏻‍♀️ Good support for dark mode (Thanks to QT). -- 🏅First class Typescript support. (Works on regular JS projects too 😉). - -## Getting Started - -- Check out [nodegui-starter](https://github.com/nodegui/nodegui-starter) to get up and running with your own React NodeGUI app! -- Read through the [docs](https://nodegui.github.io/nodegui). -- Checkout the examples: https://github.com/nodegui/examples . - -## Installation - -To install latest stable release: - -``` -npm install @nodegui/nodegui -``` - -To install the latest version available on master branch: - -``` -npm install https://github.com/nodegui/nodegui/releases/download/latest-master/nodegui-master.tgz -``` - -**Community guides** - -- https://blog.logrocket.com/electron-alternatives-exploring-nodegui-and-react-nodegui/ - Electron alternatives: Exploring NodeGUI and React NodeGUI by [Siegfried Grimbeek](https://blog.logrocket.com/author/siegfriedgrimbeek/). -- https://hibbard.eu/node-gui/ - Excellent guide from [James Hibbard](https://github.com/jameshibbard). - -**Talks/Podcasts** - -- [NodeGui and React NodeGui at KarmaJS Nov 2019 meetup: https://www.youtube.com/watch?v=8jH5gaEEDv4](https://www.youtube.com/watch?v=8jH5gaEEDv4) - --

JS Party 96: Performant Node desktop apps with NodeGUI – Listen on Changelog.com

- -## Docs for contributing - -``` -It is easier than you think, try it -``` - -Looking to contribute? If you wish to implement a new widget/add more features and need help understanding the codebase, you can start here: [Contributing developer docs](https://github.com/nodegui/nodegui/tree/master/website/docs/development). - -Please read https://github.com/nodegui/.github/blob/master/CONTRIBUTING.md - -## Building - -`npm run build` - -Optionally set `QT_INSTALL_DIR='/path/to/qt'` environment variable to build using your own version of Qt. - -## Funding - -NodeGUI is an open source project and requires your support. If you like this project, please consider supporting my work by clicking on the Sponsor button on this Github repository or via Ko-Fi. -Alternatively, Issues on NodeGui can be funded by anyone via Issuehunt and the amount will be distributed to respective contributors. - -

-Buy Me a Coffee at ko-fi.com    issuehunt -

- -## Special Thanks - -- [Logo: Thanks to Vishwas Shetty from the Noun Project.](https://github.com/nodegui/nodegui/blob/master/extras/legal/logo/thanks.md) - -## Code of Conduct - -https://github.com/nodegui/.github/blob/master/CODE_OF_CONDUCT.md - -## License - -MIT - -## Backers 🚀 - -Thanks goes to these wonderful people. - - - - - - - - - -
Yuriy Yazlovytskyy
Yuriy Yazlovytskyy		John Susek
John Susek		Marc Dijoux
Marc Dijoux		Stephen Belanger
Stephen Belanger
- -## Maintainers ✨ - -People maintaining this project. - - - - - - - -
Atul R
Atul R		Dimitar
Dimitar Nestorov
- -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Lucas Ramage
📖
Denis Sikuler
📖
Nahuel José
💬
Kakul Gupta
💻
Rahul Gaba
💻
Paweł Borecki
💻
Marcus S. Abildskov
⚠️

Átila Camurça Alves
📖
James Hibbard
💻
Soonwoo Hong
💻
Roy Sommer
💻
Paulo Coghi
🤔
Balthild Ires
💻
Dimitar Nestorov
💻

Mikko Sairio
💻
Pepijn
💻
slidinghotdog
💻
Bundyo (Kamen Bundev)
💻
feng8848
💻
Maksim Karelov
💻
mspencer92
💻
- - - - - - -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!