Adds basic docs site setup

Author: a7ul

README.md

@@ -1,8 +1,9 @@
 # React 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-6-orange.svg?style=flat-square)](#contributors)
 
-Build **performant**, **native** and **cross-platform** desktop applications with **JavaScript** + powerful **CSS like styling**.🚀
+Build **performant**, **native** and **cross-platform** desktop applications with React.🚀
 
 React NodeGUI is powered by **React** ⚛️ and **Qt5** 💚 which makes it CPU and memory efficient as compared to other chromium based solutions like electron. React NodeGUI is essentially a React renderer for [NodeGUI](https://github.com/nodegui/nodegui).
 
@@ -71,7 +72,7 @@ React NodeGUI is an open source project and requires your support. If you like t
 
 ## Special Thanks
 
-- [Logo: Thanks to Vishwas Shetty from the Noun Project.](https://github.com/nodegui/nodegui/blob/master/extras/legal/logo/thanks.md) 
+- [Logo: Thanks to Vishwas Shetty from the Noun Project.](https://github.com/nodegui/nodegui/blob/master/extras/legal/logo/thanks.md)
 
 ## Code of Conduct
 

website/.gitignore

@@ -0,0 +1,20 @@
+# dependencies
+/node_modules
+
+# production
+/build
+
+# generated files
+.docusaurus
+.cache-loader
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

website/README.md

@@ -0,0 +1,33 @@
+# Website
+
+This website is built using Docusaurus 2, a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+```
+$ GIT_USER=<Your GitHub username> USE_SSH=1 yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

website/blog/2019-05-30-welcome.md

@@ -0,0 +1,12 @@
+---
+id: welcome
+title: Welcome
+author: Atul R
+authorTitle: Maintainer @NodeGui
+authorURL: https://github.com/master-atul
+authorImageURL: https://avatars2.githubusercontent.com/u/4029423?s=460&v=4
+authorTwitter: masteratul94
+tags: [nodegui, hello]
+---
+
+This is the new blog site for NodeGui. This will be updated soon.

website/docs/api/Component.md

@@ -0,0 +1,26 @@
+---
+sidebar_label: Component
+title: Component
+---
+
+> Abstract class that is root most base class for all widgets and layouts in the NodeGui World.
+
+**This class is used to add core properties to all widgets, layouts etc in NodeGui world. Currently it helps us maintain references to the native C++ instance of the widget or layout. It also helps in preventing gc of child elements of a layout or widget**
+
+`Component` is an abstract class and hence no instances of the same should be created. It exists so that we can add core functionalities to all widgets and layouts easily. This is an internal class.
+
+**Component is the base class for YogaWidget and NodeLayout which means all widgets and layouts inherit it aswell. Its the root base class in NodeGui world**
+
+To get a clearer picture you can take a look at the Component source code here: `src/lib/core/Component/index.ts`
+
+## Static Methods
+
+There are no public static methods for Component.
+
+## Instance Properties
+
+There are no public instance properties for Component.
+
+## Instance Methods
+
+There are no public instance methods for Component.

website/docs/api/EventWidget.md

@@ -0,0 +1,63 @@
+---
+sidebar_label: EventWidget
+title: EventWidget
+---
+
+> Abstract class that adds event handling support to all widgets.
+
+**This class implements an event emitter and merges it with Qt's event and signal system. It allows us to register and unregister event and signal listener at will from javascript**
+
+`EventWidget` is an abstract class and hence no instances of the same should be created. It exists so that we can add event handling functionalities to all widget's easily. This is an internal class.
+
+**EventWidget is the base class for NodeWidget which means all widgets inherit it aswell. It inherits from another abstract class [YogaWidget](api/YogaWidget.md)**
+
+### Example
+
+```javascript
+const { QWidget, QWidgetEvents } = require("@nodegui/nodegui");
+
+const view = new QWidget();
+// addEventListener is a method from EventWidget
+view.addEventListener("MouseMove", () => {
+  console.log("mouse moved");
+});
+
+or;
+
+// addEventListener is a method from EventWidget
+view.addEventListener(QWidgetEvents.MouseMove, () => {
+  console.log("mouse moved");
+});
+```
+
+EventWidget will contain all methods and properties that are useful to handle events and signals of widgets in the NodeGui world.
+
+## Static Methods
+
+EventWidget can access all the static methods defined in [YogaWidget](api/YogaWidget.md)
+
+## Instance Properties
+
+EventWidget can access all the instance properties defined in [YogaWidget](api/YogaWidget.md)
+
+## Instance Methods
+
+EventWidget can access all the instance methods defined in [YogaWidget](api/YogaWidget.md)
+
+Additionally it also has the following instance methods:
+
+### `widget.addEventListener(eventType, callback)`
+
+Adds an event listener to the widget to listen to events that occur on a widget.
+
+- `eventType` string - The event or signal you wish to listen to for the widget. Every widget exports its own enum of all possible events and signal types it can take. For example: `QWidget` exports `QWidgetEvents`, `QPushButton` exports `QPushButtonEvents`.
+
+- `callback` (payload?: NativeEvent | any) => void - A callback function to invoke when an event occurs. Usually you receive a nativeEvent or a string as argument.
+
+### `widget.removeEventListener(eventType, callback?)`
+
+Removes the specified event listener from the widget.
+
+- `eventType` string - The event or signal for which you wish to remove the listener.
+
+- `callback` Function (_Optional_) - If specified the removeEventListener will remove the specified listener only, otherwise all eventlisteners of the eventType on the widget will be removed.

website/docs/api/FlexLayout.md

@@ -0,0 +1,73 @@
+---
+sidebar_label: FlexLayout
+title: FlexLayout
+---
+
+> Custom layout to help layout child widgets using flex layout.
+
+**This class is a JS wrapper around custom Qt layout implemented using [Yoga](https://github.com/facebook/yoga)**
+
+A `FlexLayout` can be used to layout all child NodeGui widgets using flex.
+
+**FlexLayout inherits from [NodeLayout](api/NodeLayout.md)**
+
+### Example
+
+```javascript
+const { FlexLayout, QWidget, QLabel } = require("@nodegui/nodegui");
+
+const view = new QWidget();
+const layout = new FlexLayout();
+view.setLayout(layout);
+
+const label = new QLabel();
+label.setText("label1");
+const label2 = new QLabel();
+label2.setText("label2");
+
+layout.addWidget(label);
+layout.addWidget(label2);
+```
+
+## Static Methods
+
+FlexLayout can access all the static methods defined in [NodeLayout](api/NodeLayout.md)
+
+## Instance Properties
+
+FlexLayout can access all the instance properties defined in [NodeLayout](api/NodeLayout.md)
+
+## Instance Methods
+
+FlexLayout can access all the instance methods defined in [NodeLayout](api/NodeLayout.md)
+
+Additionally it also has the following instance methods:
+
+### `layout.addWidget(childWidget, childFlexNode?)`
+
+Adds the childWidget to the layout. It calls the native method of custom FlexLayout.
+
+- `childWidget` NodeWidget - child widget that needs to be added to the layout.
+- `childFlexNode` flexNode ref (_Optional_) - flexNode reference of the child widget. You can get this by calling `childWidget.getFlexNode()`.
+
+### `layout.insertChildBefore(childWidget, beforeChildWidget, childFlexNode?, beforeChildFlexNode?)`
+
+Adds the childWidget before another already set childWidget in the layout. It calls the native method of custom FlexLayout.
+
+- `childWidget` NodeWidget - child widget that needs to be added to the layout.
+- `beforeChildWidget` NodeWidget - the widget before which the `childWidget` needs to be added in the layout.
+- `childFlexNode` flexNode ref (_Optional_) - flexNode reference of the child widget. You can get this by calling `childWidget.getFlexNode()`.
+- `beforeChildFlexNode` flexNode ref (_Optional_) - flexNode reference of the before child widget. You can get this by calling `beforeChildWidget.getFlexNode()`.
+
+### `layout.removeWidget(childWidget, childFlexNode?)`
+
+Removes the childWidget from the layout. It calls the native method of custom FlexLayout.
+
+- `childWidget` NodeWidget - child widget that needs to be added to the layout.
+- `childFlexNode` flexNode ref (_Optional_) - flexNode reference of the child widget. You can get this by calling `childWidget.getFlexNode()`.
+
+### `layout.setFlexNode(flexNode)`
+
+A layout doesnt have its own flexNode. This method sets the flex Node to use for calculating position of the child widgets. Hence this should be always equal to the flex node of widget for which this layout is set. This is called internally by `widget.setLayout`.
+
+- `flexNode` flexNode ref - flexNode reference of the widget for which this layout is set. You can get this by calling `widget.getFlexNode()`.

website/docs/api/NodeLayout.md

@@ -0,0 +1,74 @@
+---
+sidebar_label: NodeLayout
+title: NodeLayout
+---
+
+> Abstract class to add functionalities common to all Layout.
+
+**This class implements all methods, properties of Qt's [QLayout class](https://doc.qt.io/qt-5/qlayout.html) so that it can be inherited by all layouts**
+
+`NodeLayout` is an abstract class and hence no instances of the same should be created. It exists so that we can add similar functionalities to all layout's easily. Additionally it helps in typechecking process.
+
+**NodeLayout is the base class for all layouts. It inherits from another abstract class [Component](api/Component.md)**
+
+### Example
+
+```javascript
+const {
+  NodeLayout,
+  NodeWidget,
+  FlexLayout,
+  GridLayout,
+  QPushButton,
+  QWidget
+} = require("@nodegui/nodegui");
+
+// addChildToLayout can accept any layout since it expects NodeLayout
+const addChildToLayout = (layout: NodeLayout, widget: NodeWidget) => {
+  layout.addWidget(widget);
+};
+
+addChildToLayout(new FlexLayout(), new QPushButton());
+addChildToLayout(new GridLayout(), new QWidget());
+```
+
+NodeLayout will list all methods and properties that are common to all layouts in the NodeGui world.
+
+## Static Methods
+
+NodeLayout can access all the static methods defined in [Component](api/Component.md)
+
+## Instance Properties
+
+NodeLayout can access all the instance properties defined in [Component](api/Component.md)
+
+Additionally it also has the following instance properties:
+
+### `layout.type`
+
+This will return the string `layout` for all layouts.
+
+## Instance Methods
+
+NodeLayout can access all the instance methods defined in [Component](api/Component.md)
+
+Additionally it also has the following instance methods:
+
+### `layout.addWidget(childWidget, ...args)`
+
+This is an abstract method in NodeLayout class. All Layouts inheriting from NodeLayout should implement this method.
+
+- `childWidget` NodeWidget - Any widget in the NodeGui world.
+- `...args` any[] - Additional params as required by the layout.
+
+### `layout.activate()`
+
+Redoes the layout for parent widget of this layout if necessary. Returns true if the layout was redone.
+
+### `layout.invalidate()`
+
+Invalidates any cached information in this layout.
+
+### `layout.update()`
+
+Updates the layout for parent widget of this layout. You should generally not need to call this because it is automatically called at the most appropriate times.