git0 0.2.11 → 0.2.12

package/svelte-nodegui/website/docs/api/interfaces/windowprops.md

@@ -1,245 +0,0 @@
----
-id: "windowprops"
-title: "WindowProps"
-sidebar_label: "WindowProps"
----
-
-## Hierarchy
-
-  ↳ [ViewProps](viewprops.md)‹QMainWindowSignals›
-
-  ↳ **WindowProps**
-
-## Index
-
-### Properties
-
-* [attributes](windowprops.md#optional-attributes)
-* [cursor](windowprops.md#optional-cursor)
-* [enabled](windowprops.md#optional-enabled)
-* [geometry](windowprops.md#optional-geometry)
-* [id](windowprops.md#optional-id)
-* [maxSize](windowprops.md#optional-maxsize)
-* [menuBar](windowprops.md#optional-menubar)
-* [minSize](windowprops.md#optional-minsize)
-* [mouseTracking](windowprops.md#optional-mousetracking)
-* [on](windowprops.md#optional-on)
-* [pos](windowprops.md#optional-pos)
-* [ref](windowprops.md#optional-ref)
-* [size](windowprops.md#optional-size)
-* [style](windowprops.md#optional-style)
-* [styleSheet](windowprops.md#optional-stylesheet)
-* [visible](windowprops.md#optional-visible)
-* [windowFlags](windowprops.md#optional-windowflags)
-* [windowIcon](windowprops.md#optional-windowicon)
-* [windowOpacity](windowprops.md#optional-windowopacity)
-* [windowState](windowprops.md#optional-windowstate)
-* [windowTitle](windowprops.md#optional-windowtitle)
-
-## Properties
-
-### `Optional` attributes
-
-• **attributes**? : *[WidgetAttributesMap](../globals.md#widgetattributesmap)*
-
-*Inherited from [ViewProps](viewprops.md).[attributes](viewprops.md#optional-attributes)*
-
-Prop to set the Widget Attributes. example:
-`<View attributes={{[WidgetAttributes.WA_Disabled]: true}} />`
-
-___
-
-### `Optional` cursor
-
-• **cursor**? : *CursorShape | QCursor*
-
-*Inherited from [ViewProps](viewprops.md).[cursor](viewprops.md#optional-cursor)*
-
-Sets the window mouse cursor. [QWidget: setCursor](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetcursorcursor)
-
-___
-
-### `Optional` enabled
-
-• **enabled**? : *undefined | false | true*
-
-*Inherited from [ViewProps](viewprops.md).[enabled](viewprops.md#optional-enabled)*
-
-Sets the property that tells whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. [QWidget: setEnabled](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetenabledenabled)
-
-___
-
-### `Optional` geometry
-
-• **geometry**? : *[Geometry](../globals.md#geometry)*
-
-*Inherited from [ViewProps](viewprops.md).[geometry](viewprops.md#optional-geometry)*
-
-Sets the screen position as well as size of the widget. [QWidget: setGeometry](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetgeometryx-y-width-height)
-
-___
-
-### `Optional` id
-
-• **id**? : *undefined | string*
-
-*Inherited from [ViewProps](viewprops.md).[id](viewprops.md#optional-id)*
-
-Sets the object name (id) of the widget in Qt. Object name can be analogous to id of an element in the web world. Using the objectName of the widget one can reference it in the Qt's stylesheet much like what we do with id in the web world. [QWidget: setObjectName](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetobjectnameobjectname)
-
-___
-
-### `Optional` maxSize
-
-• **maxSize**? : *[Size](../globals.md#size)*
-
-*Inherited from [ViewProps](viewprops.md).[maxSize](viewprops.md#optional-maxsize)*
-
-Sets the maximum size of the widget. [QWidget: setMaximumSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetmaximumsizewidth-height)
-
-___
-
-### `Optional` menuBar
-
-• **menuBar**? : *QMenuBar*
-
-___
-
-### `Optional` minSize
-
-• **minSize**? : *[Size](../globals.md#size)*
-
-*Inherited from [ViewProps](viewprops.md).[minSize](viewprops.md#optional-minsize)*
-
-Sets the minimum size of the widget. [QWidget: setMinimumSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetminimumsizewidth-height)
-
-___
-
-### `Optional` mouseTracking
-
-• **mouseTracking**? : *undefined | false | true*
-
-*Inherited from [ViewProps](viewprops.md).[mouseTracking](viewprops.md#optional-mousetracking)*
-
-Sets the property that tells whether mouseTracking is enabled for the widget. [QWidget: setMouseTracking](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetmousetrackingismousetracked)
-
-___
-
-### `Optional` on
-
-• **on**? : *Partial‹[WidgetEventListeners](../globals.md#widgeteventlisteners) | QMainWindowSignals›*
-
-*Inherited from [ViewProps](viewprops.md).[on](viewprops.md#optional-on)*
-
-Prop to set the event listener map. See [Handlong Events](/docs/guides/handle-events)
-
-___
-
-### `Optional` pos
-
-• **pos**? : *[Position](../globals.md#position)*
-
-*Inherited from [ViewProps](viewprops.md).[pos](viewprops.md#optional-pos)*
-
-Sets the screen position of the widget. [QWidget: move](https://docs.nodegui.org/docs/api/NodeWidget#widgetmovex-y)
-
-___
-
-### `Optional` ref
-
-• **ref**? : *any*
-
-*Inherited from [ViewProps](viewprops.md).[ref](viewprops.md#optional-ref)*
-
-Prop to set the ref. The ref will return the underlying nodegui widget.
-
-___
-
-### `Optional` size
-
-• **size**? : *[ViewSize](../globals.md#viewsize)*
-
-*Inherited from [ViewProps](viewprops.md).[size](viewprops.md#optional-size)*
-
-Sets both the minimum and maximum sizes of the widget. [QWidget: setFixedSize](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetfixedsizewidth-height)
-
-___
-
-### `Optional` style
-
-• **style**? : *undefined | string*
-
-*Inherited from [ViewProps](viewprops.md).[style](viewprops.md#optional-style)*
-
-Sets the inline stylesheet property. [QWidget: setInlineStyle](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetinlinestylestyle)
-
-___
-
-### `Optional` styleSheet
-
-• **styleSheet**? : *undefined | string*
-
-*Inherited from [ViewProps](viewprops.md).[styleSheet](viewprops.md#optional-stylesheet)*
-
-Sets the property that holds the widget's style sheet. [QWidget: setStyleSheet](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetstylesheetstylesheet)
-
-___
-
-### `Optional` visible
-
-• **visible**? : *undefined | false | true*
-
-*Inherited from [ViewProps](viewprops.md).[visible](viewprops.md#optional-visible)*
-
-Shows or hides the widget and its children. [QWidget: show](https://docs.nodegui.org/docs/api/NodeWidget#widgetshow)
-
-___
-
-### `Optional` windowFlags
-
-• **windowFlags**? : *[WindowFlagsMap](../globals.md#windowflagsmap)*
-
-*Inherited from [ViewProps](viewprops.md).[windowFlags](viewprops.md#optional-windowflags)*
-
-Prop to set the Widget flags. example:
-`<View windowFlags={{[WindowType.SplashScreen]: true}} />`
-
-___
-
-### `Optional` windowIcon
-
-• **windowIcon**? : *QIcon*
-
-*Inherited from [ViewProps](viewprops.md).[windowIcon](viewprops.md#optional-windowicon)*
-
-Sets the window icon. [QWidget: setWindowIcon](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowiconicon)
-
-___
-
-### `Optional` windowOpacity
-
-• **windowOpacity**? : *undefined | number*
-
-*Inherited from [ViewProps](viewprops.md).[windowOpacity](viewprops.md#optional-windowopacity)*
-
-This property holds the level of opacity for the window. [QWidget: setWindowOpacity](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowopacityopacity)
-
-___
-
-### `Optional` windowState
-
-• **windowState**? : *WindowState*
-
-*Inherited from [ViewProps](viewprops.md).[windowState](viewprops.md#optional-windowstate)*
-
-Sets the window state. [QWidget: setWindowState](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowstatestate)
-
-___
-
-### `Optional` windowTitle
-
-• **windowTitle**? : *undefined | string*
-
-*Inherited from [ViewProps](viewprops.md).[windowTitle](viewprops.md#optional-windowtitle)*
-
-Sets the window title property. [QWidget: setWindowTitle](https://docs.nodegui.org/docs/api/NodeWidget#widgetsetwindowtitletitle)

package/svelte-nodegui/website/docs/api/modules/_react_proxy_.md

@@ -1,29 +0,0 @@
----
-id: "_react_proxy_"
-title: "react-proxy"
-sidebar_label: "react-proxy"
----
-
-## Index
-
-### Interfaces
-
-* [ReactProxyComponent](../interfaces/_react_proxy_.reactproxycomponent.md)
-
-### Functions
-
-* [createProxy](_react_proxy_.md#createproxy)
-
-## Functions
-
-###  createProxy
-
-▸ **createProxy**(`Component`: React.ComponentType): *[ReactProxyComponent](../interfaces/_react_proxy_.reactproxycomponent.md)*
-
-**Parameters:**
-
-Name | Type |
------- | ------ |
-`Component` | React.ComponentType |
-
-**Returns:** *[ReactProxyComponent](../interfaces/_react_proxy_.reactproxycomponent.md)*

package/svelte-nodegui/website/docs/doc1.md

@@ -1,162 +0,0 @@
----
-id: doc1
-title: Style Guide
-sidebar_label: Style Guide
----
-
-You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/).
-
-## Markdown Syntax
-
-To serve as an example page when styling markdown based Docusaurus sites.
-
-## Headers
-
-# H1 - Create the best documentation
-
-## H2 - Create the best documentation
-
-### H3 - Create the best documentation
-
-#### H4 - Create the best documentation
-
-##### H5 - Create the best documentation
-
-###### H6 - Create the best documentation
-
----
-
-## Emphasis
-
-Emphasis, aka italics, with _asterisks_ or _underscores_.
-
-Strong emphasis, aka bold, with **asterisks** or **underscores**.
-
-Combined emphasis with **asterisks and _underscores_**.
-
-Strikethrough uses two tildes. ~~Scratch this.~~
-
----
-
-## Lists
-
-1. First ordered list item
-1. Another item ⋅⋅\* Unordered sub-list.
-1. Actual numbers don't matter, just that it's a number ⋅⋅1. Ordered sub-list
-1. And another item.
-
-⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown).
-
-⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ ⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ ⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
-
-- Unordered list can use asterisks
-
-* Or minuses
-
-- Or pluses
-
----
-
-## Links
-
-[I'm an inline-style link](https://www.google.com)
-
-[I'm an inline-style link with title](https://www.google.com "Google's Homepage")
-
-[I'm a reference-style link][arbitrary case-insensitive reference text]
-
-[I'm a relative reference to a repository file](../blob/master/LICENSE)
-
-[You can use numbers for reference-style link definitions][1]
-
-Or leave it empty and use the [link text itself].
-
-URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or <http://www.example.com> and sometimes example.com (but not on Github, for example).
-
-Some text to show that the reference links can follow later.
-
-[arbitrary case-insensitive reference text]: https://www.mozilla.org
-[1]: http://slashdot.org
-[link text itself]: http://www.reddit.com
-
----
-
-## Images
-
-Here's our logo (hover to see the title text):
-
-Inline-style: ![alt text](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 1')
-
-Reference-style: ![alt text][logo]
-
-[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2'
-
----
-
-## Code
-
-```javascript
-var s = 'JavaScript syntax highlighting';
-alert(s);
-```
-
-```python
-s = "Python syntax highlighting"
-print s
-```
-
-```
-No language indicated, so no syntax highlighting.
-But let's throw in a <b>tag</b>.
-```
-
----
-
-## Tables
-
-Colons can be used to align columns.
-
-| Tables        |      Are      |   Cool |
-| ------------- | :-----------: | -----: |
-| col 3 is      | right-aligned | \$1600 |
-| col 2 is      |   centered    |   \$12 |
-| zebra stripes |   are neat    |    \$1 |
-
-There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown.
-
-| Markdown | Less      | Pretty     |
-| -------- | --------- | ---------- |
-| _Still_  | `renders` | **nicely** |
-| 1        | 2         | 3          |
-
----
-
-## Blockquotes
-
-> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
-
-Quote break.
-
-> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote.
-
----
-
-## Inline HTML
-
-<dl>
-  <dt>Definition list</dt>
-  <dd>Is something people use sometimes.</dd>
-
-  <dt>Markdown in HTML</dt>
-  <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd>
-</dl>
-
----
-
-## Line Breaks
-
-Here's a line for us to start with.
-
-This line is separated from the one above by two newlines, so it will be a _separate paragraph_.
-
-This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_.

package/svelte-nodegui/website/docs/guides/custom-nodegui-native-plugin.md

@@ -1,6 +0,0 @@
----
-sidebar_label: Custom Svelte NodeGui Plugin
-title: Custom Svelte NodeGui Plugin
----
-
-WIP

package/svelte-nodegui/website/docs/guides/debugging-in-vscode.md

@@ -1,39 +0,0 @@
----
-sidebar_label: Debugging in VSCode
-title: Debugging in VSCode
----
-
-- **Open a NodeGui project in VSCode.**
-
-  ```sh
-  $ git clone git@github.com:nodegui/svelte-nodegui-starter.git
-  $ code svelte-nodegui-starter
-  ```
-
-- **Add a file `.vscode/launch.json` with the following configuration:**
-
-  ```json
-  {
-    "version": "0.2.0",
-    "configurations": [
-      {
-        "name": "Debug Qode Process",
-        "type": "node",
-        "request": "launch",
-        "cwd": "${workspaceRoot}",
-        "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/qode",
-        "windows": {
-          "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/qode.exe"
-        },
-        "args": ["./dist/index.js"],
-        "outputCapture": "std"
-      }
-    ]
-  }
-  ```
-
-  **Tip**: You could also configure a preLaunchTask for building typescript before launching the debugger everytime.
-
-- **Debugging**
-
-Set some breakpoints in `index.js`, and start debugging in the [Debug View](https://code.visualstudio.com/docs/editor/debugging). You should be able to hit the breakpoints.

package/svelte-nodegui/website/docs/guides/debugging.md

@@ -1,59 +0,0 @@
----
-sidebar_label: Debugging
-title: Debugging
----
-
-## Application Debugging
-
-Whenever your Svelte NodeGui application is not behaving the way you wanted it to,
-an array of debugging tools might help you find coding errors, performance
-bottlenecks, or optimization opportunities.
-
-Since a Svelte NodeGui application runs on Qode and Qode is essentially Node.js. We can consider a NodeGui app as a regular NodeJs app. Hence, you can use any debugging tool that you use with Node.Js
-One of the most popular way of debugging a Node.Js app is by making use of the [Chromium Developer Tools][node-inspect].
-
-Google offers [excellent documentation for their developer tools][devtools].
-We recommend that you make yourself familiar with them - they are usually one
-of the most powerful utilities in any NodeGui Developer's tool belt.
-
-## Debugging Qode process
-
-To debug JavaScript that's executed in the Qode/Node process you will need to use an external debugger and
-launch Qode with the `--inspect` or `--inspect-brk` switch. Once you run it you can open up Chrome and visit `chrome://inspect` where you should see your app listed.
-
-### Command Line Switches
-
-Use one of the following command line switches to enable debugging of the process:
-
-#### `--inspect=[port]`
-
-Qode will listen for V8 inspector protocol messages on the specified `port`,
-an external debugger will need to connect on this port. The default `port` is
-`9229`.
-
-```shell
-qode --inspect=9229 your/app
-```
-
-#### `--inspect-brk=[port]`
-
-Like `--inspect` but pauses execution on the first line of JavaScript.
-
-**Note**
-
-If you are using the official boilerplate `nodegui-starter`, then you can achieve this by running
-
-```
-npm run debug
-```
-
-### External Debuggers
-
-You will need to use a debugger that supports the V8 inspector protocol.
-
-- Connect Chrome by visiting `chrome://inspect` and selecting to inspect the
-  launched NodeGui app present there.
-- [Debugging the NodeGui app in VSCode](debugging-in-vscode.md)
-
-[node-inspect]: https://nodejs.org/en/docs/inspector/
-[devtools]: https://developer.chrome.com/devtools

package/svelte-nodegui/website/docs/guides/getting-started.md

@@ -1,141 +0,0 @@
----
-sidebar_label: Getting started
-title: Getting started
----
-
-Svelte NodeGui enables you to create desktop applications with Svelte. You could see it
-as a lightly modified variant of the Node.js runtime that is focused on desktop applications
-instead of web servers.
-
-Svelte NodeGui is a Svelte renderer for [NodeGui](https://nodegui.org), which is an efficient JavaScript binding to a cross platform graphical user interface
-(GUI) library `Qt`. Qt is one of the most mature and efficient library for building desktop applications.
-This enabled Svelte NodeGui to be extremely memory and CPU efficient as compared to other popular Javascript Desktop GUI solutions. A hello world app built with Svelte NodeGui runs on less than 20Mb of memory.
-
-## Developer environment
-
-To turn your operating system into an environment capable of building desktop apps with Svelte NodeGui, you would need Node.js, npm, a code editor of your choice, and a rudimentary understanding of your operating system's command line client.
-
-Along with these, there are a few operating system dependent instructions that are listed below.
-
-### Setting up on macOS
-
-**Requirements:**
-
-- Svelte NodeGui supports macOS 10.10 (Yosemite) and up. NodeGui currently only supports 64bit OS.
-- CMake 3.1 and up (Installation instructions can be found here: https://cmake.org/install/)
-- Make, GCC v7
-- Currently supported Node.Js versions are 12.x and up.
-
-We strongly suggest you use some kind of version manager for Node.Js. This would allow you to switch to any version of nodejs quite easily. We recommend `nvm`: https://github.com/nvm-sh/nvm
-
-Confirm that both `node` and `npm` are available by running:
-
-```sh
-# This command should print the version of Node.js
-node -v
-
-# This command should print the version of npm
-npm -v
-```
-
-If both commands printed a version number, you are all set! Before you get
-started, you might want to install a [code editor](#a-good-editor) suited
-for JavaScript development.
-
-### Setting up on Windows
-
-> Svelte NodeGui supports Windows 7 and later versions – attempting to develop NodeGui
-> applications on earlier versions of Windows might not work. NodeGui currently only supports 64bit OS.
-
-**Requirements:**
-
-- Visual studio 2017 and up.
-- CMake 3.1 and up (Installation instructions can be found here: https://cmake.org/install/)
-- Currently supported Node.Js versions are 12.x and up.
-
-We strongly suggest you use some kind of version manager for Node.Js. This would allow you to switch to any version of nodejs quite easily. We recommend `nvm`: https://github.com/nvm-sh/nvm
-
-We strongly recommend Powershell as preferred terminal in Windows.
-
-Confirm that both `node` and `npm` are available by running:
-
-```powershell
-# This command should print the version of Node.js
-node -v
-
-# This command should print the version of npm
-npm -v
-```
-
-If both commands printed a version number, you are all set! Before you get
-started, you might want to install a [code editor](#a-good-editor) suited
-for JavaScript development.
-
-### Setting up on Linux
-
-> Svelte NodeGui currently supports Ubuntu 16.04 and Debian 10 and up. Although other Linux distributions can also be easily supported. NodeGui currently only supports 64bit OS.
-
-**Requirements:**
-
-- Make, GCC v7
-- CMake 3.1 and up (Installation instructions can be found here: https://cmake.org/install/)
-- Currently supported Node.Js versions are 12.x and up.
-- On Ubuntu and Ubuntu-based distros it is advisable to run `sudo apt-get update`, followed by `sudo apt-get install pkg-config build-essential`
-
-We strongly suggest you use some kind of version manager for Node.Js. This would allow you to switch to any version of nodejs quite easily. We recommend `nvm`: https://github.com/nvm-sh/nvm
-
-Confirm that both `node` and `npm` are available by running:
-
-```sh
-# This command should print the version of Node.js
-node -v
-
-# This command should print the version of npm
-npm -v
-```
-
-If both commands printed a version number, you are all set! Before you get
-started, you might want to install a [code editor](#a-good-editor) suited
-for JavaScript development.
-
-### A Good Editor
-
-We might suggest two free popular editors:
-GitHub's [Atom][atom] and Microsoft's [Visual Studio Code][code]. Both of
-them have excellent JavaScript support.
-
-If you are one of the many developers with a strong preference, know that
-virtually all code editors and IDEs these days support JavaScript.
-
-[code]: https://code.visualstudio.com/
-[atom]: https://atom.io/
-
-### Hello World
-
-Clone and run the code in this tutorial by using the
-[`nodegui/svelte-nodegui-starter`][quick-start] repository.
-
-**Note**: Running this requires [Git](https://git-scm.com) and [npm](https://www.npmjs.com/).
-
-```sh
-# Clone the repository
-$ git clone https://github.com/nodegui/svelte-nodegui-starter
-# Go into the repository
-$ cd svelte-nodegui-starter
-# Install dependencies
-$ npm install
-# Run the dev server
-$ npm run dev
-# Run the app on a separate terminal tab or window
-$ npm start
-```
-
-That's it!
-
-Congratulations! You've successfully run and modified your first Svelte NodeGui app.
-
-### Now what?
-
-If you're curious to learn more about Svelte NodeGui, continue on to the [tutorial](tutorial.md).
-
-[quick-start]: https://github.com/nodegui/svelte-nodegui-starter