Skip to content

Commit 2f7af4d

Browse files
authored
Merge pull request #161 from retejs/lit-docs
Lit docs
2 parents c6c3d35 + c86ad80 commit 2f7af4d

File tree

30 files changed

+630
-68
lines changed

30 files changed

+630
-68
lines changed

content/en/docs/1.index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ keywords: introduction,ecosystem
1818

1919
In the interactive example above, you can see the notation of the basic elements of the classic editor view and the graph processing using the Dataflow-based engine. This demonstrates the essential capabilities of the framework:
2020

21-
- **Visualization**: you can choose React.js, Vue.js, Angular or Svelte to visualize nodes, sockets, controls, and connections. These visual components can be tailored to your specific needs by creating custom components for each framework, and they can all coexist in a single editor.
21+
- **Visualization**: you can choose React.js, Vue.js, Angular, Svelte or Lit to visualize nodes, sockets, controls, and connections. These visual components can be tailored to your specific needs by creating custom components for each framework, and they can all coexist in a single editor.
2222
- **Processing**: the framework offers various types of engines that enable processing diagrams based on their nature, including dataflow and control flow. These types can be combined within the same graph.
2323

2424
:youtube-video{name="intro"}

content/en/docs/19.quality-assurance.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ The main purpose of this tool is to conduct regression UI testing on different c
3333

3434
Additionally, we test our framework on various versions of commonly used UI frameworks, such as Angular, Svelte, Vue.js, and React.js. This gives us **27** test runs across different environments as we have a matrix of browsers and framework versions
3535

36-
| Browser \ Stack | Angular 16 | Angular 14 | Angular 12 | Svelte 4 | Svelte 3 | Vue.js 3 | Vue.js 2 | React.js 18 | React.js 16 |
37-
| :-------------: | :--------: | :--------: | :--------: | :------: | :------: | :------: | :------: | :---------: | :---------: |
38-
| Chromium ||||||||||
39-
| Firefox ||||||||||
40-
| WebKit ||||||||||
36+
| Browser \ Stack | Angular 16 | Angular 14 | Angular 12 | Svelte 4 | Svelte 3 | Vue.js 3 | Vue.js 2 | React.js 18 | React.js 16 | Lit 3 |
37+
| :-------------: | :--------: | :--------: | :--------: | :------: | :------: | :------: | :------: | :---------: | :---------: | :---------: |
38+
| Chromium |||||||||||
39+
| Firefox |||||||||||
40+
| WebKit |||||||||||
4141

4242
### Installation {#install}
4343

content/en/docs/2.getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ keywords: getting started,install,setup,prerequisites,playgrounds,fork,rete kit
1212
:ref-external{title="Codepen" link="https://codepen.io/Ni55aN/pen/rNZKejd"}
1313
::
1414

15-
There are two easy ways to begin working with the framework: forking [the examples](/examples) on Codesandbox or creating a local application using [Rete Kit](/docs/development/rete-kit). The first option allows for experimentation with functionality, which not always covered in the guides. Alternatively, the second option enables the creation of a local application with specific node editor features for a chosen version of **React.js**, **Vue.js**, **Angular** or **Svelte**. Afterward, following the guides will help familiarize yourself with the framework's features and capabilities.
15+
There are two easy ways to begin working with the framework: forking [the examples](/examples) on Codesandbox or creating a local application using [Rete Kit](/docs/development/rete-kit). The first option allows for experimentation with functionality, which not always covered in the guides. Alternatively, the second option enables the creation of a local application with specific node editor features for a chosen version of **React.js**, **Vue.js**, **Angular**, **Svelte** or **Lit**. Afterward, following the guides will help familiarize yourself with the framework's features and capabilities.
1616

1717
:youtube-video{name="getting-started"}
1818

@@ -29,7 +29,7 @@ If TypeScript is your preferred choice, make sure you have TypeScript version 4.
2929

3030
## Creating an application using devkit {#devkit}
3131

32-
Use [Rete Kit](/docs/development/rete-kit) to quickly set up a Rete.js application. It lets you select a stack (**React.js**, **Vue.js**, **Angular** or **Svelte**) and the set of features.
32+
Use [Rete Kit](/docs/development/rete-kit) to quickly set up a Rete.js application. It lets you select a stack (**React.js**, **Vue.js**, **Angular**, **Svelte** or **Lit**) and the set of features.
3333

3434
## Adding Rete.js to your application {#app}
3535

content/en/docs/20.development/3.rete-kit.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
description: Simplify your plugin and project development with Rete Kit. Create basic plugin structures instantly and setup an application from a variety of templates to get started quickly
3-
keywords: development,kit,setup,bootstrap,react.js,vue.js,angular,svelte,vite.js,nuxt,next
3+
keywords: development,kit,setup,bootstrap,react.js,vue.js,angular,svelte,lit,vite.js,nuxt,next
44
---
55

66
# Rete Kit
@@ -12,6 +12,7 @@ keywords: development,kit,setup,bootstrap,react.js,vue.js,angular,svelte,vite.js
1212
:ref-external{title="React.js" link="https://react.dev/"}
1313
:ref-external{title="Vite.js" link="https://vitejs.dev/"}
1414
:ref-external{title="Svelte" link="https://svelte.dev/"}
15+
:ref-external{title="Lit" link="https://lit.dev/"}
1516
:ref-external{title="Next.js" link="https://nextjs.org/"}
1617
:ref-external{title="Nuxt" link="https://nuxt.com/"}
1718
::
@@ -47,7 +48,7 @@ rete-kit app --name <name> --stack <stack> --stack-version <version> --features
4748
```
4849

4950
where
50-
- `<stack>` option lets you choose `angular`, `vue`, `vue-vite`, `react`, `react-vite`, `svelte`, `vite`, `next` or `nuxt`
51+
- `<stack>` option lets you choose `angular`, `vue`, `vue-vite`, `react`, `react-vite`, `svelte`, `lit-vite`, `vite`, `next` or `nuxt`
5152
- `<features>` is a comma-separated list of the Rete.js editor features
5253
- `<deps-alias>` is a JSON file that maps dependencies. By default, it installs the latest version from npmjs, but you can specify a different version using the format `name@version` or a path to the tarball
5354

content/en/docs/24.FAQ.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,28 +119,28 @@ keywords:
119119
```
120120
::
121121
::qa{question="How to customize nodes?" id="customize-node"}
122-
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization) or [Svelte](/docs/guides/renderers/svelte#customization).
122+
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization), [Svelte](/docs/guides/renderers/svelte#customization) or [Lit](/docs/guides/renderers/lit#customization).
123123
::
124124
::qa{question="How to collapse the node (to minimize a node's size by hiding its controls)?" id="collapse-node"}
125125
Define how elements should be hidden when the node is collapsed by creating a custom node component.
126126

127-
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization) or [Svelte](/docs/guides/renderers/svelte#customization).
127+
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization), [Svelte](/docs/guides/renderers/svelte#customization) or [Lit](/docs/guides/renderers/lit#customization).
128128
::
129129
::qa{question="What are the steps to implement render plugin for other framework?" id="new-render-plugins"}
130130
- [Setup a plugin](/docs/development/#create-plugin)
131-
- Use the source code of the following packages as a reference: [React.js](https://github.com/retejs/react-plugin), [Vue.js](https://github.com/retejs/vue-plugin), [Angular](https://github.com/retejs/angular-plugin) or [Svelte](https://github.com/retejs/svelte-plugin).
131+
- Use the source code of the following packages as a reference: [React.js](https://github.com/retejs/react-plugin), [Vue.js](https://github.com/retejs/vue-plugin), [Angular](https://github.com/retejs/angular-plugin), [Svelte](https://github.com/retejs/svelte-plugin) or [Lit](https://github.com/retejs/lit-plugin)
132132

133133
::
134134
::qa{question="Is there way to prevent nodes from being moved while interacting with controls?" id="prevent-node-movement-on-control"}
135135
You need to stop propagation of the `pointerdown` event.
136136

137-
Check the relevant render plugin guide for controls: [React.js](guides/renderers/react#controls), [Vue.js](guides/renderers/vue#controls), [Angular](guides/renderers/angular#controls), [Svelte](guides/renderers/svelte#controls)
137+
Check the relevant render plugin guide for controls: [React.js](guides/renderers/react#controls), [Vue.js](guides/renderers/vue#controls), [Angular](guides/renderers/angular#controls), [Svelte](guides/renderers/svelte#controls), [Lit](guides/renderers/lit#controls)
138138

139139
::
140140
::qa{question="Why doesn't the control capture click/pointer events?" id="click-event-doesnt-work-on-control"}
141141
By default, the area captures these events, so you need to stop the propagation of `pointerdown` event to prevent this
142142

143-
Check the relevant render plugin guide for controls: [React.js](guides/renderers/react#controls), [Vue.js](guides/renderers/vue#controls), [Angular](guides/renderers/angular#controls), [Svelte](guides/renderers/svelte#controls)
143+
Check the relevant render plugin guide for controls: [React.js](guides/renderers/react#controls), [Vue.js](guides/renderers/vue#controls), [Angular](guides/renderers/angular#controls), [Svelte](guides/renderers/svelte#controls), [Lit](guides/renderers/lit#controls)
144144
::
145145
::qa{question="Is there a way to make the text within a node selectable?" id="user-select"}
146146
By default, a node is configured with the CSS property `user-select: none` to prevent conflict between text selection and node dragging.
@@ -174,7 +174,7 @@ keywords:
174174
::qa{question="How to add a control to the output?" id="add-control-to-output"}
175175
The process of adding such elements requires the creation of a custom node.
176176

177-
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization) or [Svelte](/docs/guides/renderers/svelte#customization).
177+
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization), [Svelte](/docs/guides/renderers/svelte#customization) or [Lit](/docs/guides/renderers/lit#customization).
178178
::
179179
::qa{question="How to create an undirected graph with nodes that don't have input/output sockets?" id="undirected-graph"}
180180
You can use the classic preset with custom nodes and a unified socket for both input and output port.
@@ -200,7 +200,7 @@ keywords:
200200
::qa{question="How to change the alignment of inputs/outputs?" id="align-inputs-outputs"}
201201
The process of changing the node layout requires the creation of a custom node.
202202

203-
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization) or [Svelte](/docs/guides/renderers/svelte#customization).
203+
Check out the relevant customization guide for [React.js](/docs/guides/renderers/react#customization), [Vue.js](/docs/guides/renderers/vue#customization), [Angular](/docs/guides/renderers/angular#customization), [Svelte](/docs/guides/renderers/svelte#customization) or [Lit](/docs/guides/renderers/lit#customization).
204204
::
205205
::qa{question="Is it possible to render UI using vanilla JS exclusively, without resorting to frameworks?" id="render-vanilla-js"}
206206
In short, it is possible, but there is no plugin available for this approach since it doesn't offer significant advantages in comparison to the development costs
@@ -274,7 +274,7 @@ keywords:
274274
```
275275
::
276276
::qa{question="What if my app uses different stack and isn't based on React.js, Vue.js, or Angular?" id="different-stack"}
277-
In case you're using a framework other than React.js, Vue.js, Angular or Svelte (for which Rete.js provides a rendering plugin), you have the option to utilize the [React.js plugin](/docs/guides/renderers/react) to render nodes and other editor elements.
277+
In case you're using a framework other than React.js, Vue.js, Angular, Svelte or Lit (for which Rete.js provides a rendering plugin), you have the option to utilize the [React.js plugin](/docs/guides/renderers/react) to render nodes and other editor elements.
278278

279279
For a quick start, you can create a React.js application using [Rete Kit](/docs/development/rete-kit), copy the code of the editor from `src/rete/default.tsx`, install the relevant dependencies in your project and call `createEditor`, providing the HTMLElement container created by your application.
280280
::

content/en/docs/24.api/0.overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Explore the packages listed below to access their API documentation
2828

2929
## Integration
3030

31-
:api-overview{filter="rete-react-plugin,rete-vue-plugin,rete-angular-plugin,rete-svelte-plugin"}
31+
:api-overview{filter="rete-react-plugin,rete-vue-plugin,rete-angular-plugin,rete-svelte-plugin,@retejs/lit-plugin"}
3232

3333
## Visualization
3434

content/en/docs/3.concepts/6.integration.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
---
2-
description: Learn how to integrate Rete.js with your favorite UI framework, such as Angular, Svelte, Vue.js, or React.js, using the available rendering packages
3-
keywords: integration,ui,rendering,react.js,vue.js,angular,svelte
2+
description: Learn how to integrate Rete.js with your favorite UI framework, such as Angular, Svelte, Lit, Vue.js, or React.js, using the available rendering packages
3+
keywords: integration,ui,rendering,react.js,vue.js,angular,svelte,lit
44
---
55

66
# Integration
77

88
:diagram{name="integration/architecture" caption="Architecture"}
99

10-
This framework is not bound to any UI rendering framework and can be integrated with the most popular frameworks/libraries such as **Angular**, **Svelte**, **Vue.js**, **React.js**. The following rendering packages are available:
10+
This framework is not bound to any UI rendering framework and can be integrated with the most popular frameworks/libraries such as **Angular**, **Svelte**, **Lit**, **Vue.js**, **React.js**. The following rendering packages are available:
1111

1212
- [`rete-react-plugin`](https://www.npmjs.com/package/rete-react-plugin)
1313
- [`rete-vue-plugin`](https://www.npmjs.com/package/rete-vue-plugin)
1414
- [`rete-angular-plugin`](https://www.npmjs.com/package/rete-angular-plugin)
1515
- [`rete-svelte-plugin`](https://www.npmjs.com/package/rete-svelte-plugin)
16+
- [`@retejs/lit-plugin`](https://www.npmjs.com/package/@retejs/lit-plugin)
1617

1718
The primary objective is to empower you to choose the visualization tools that align with your specific needs. Additionally, if you ever need to use the render plugin for a different framework within your application (such as during a project migration), you can easily do so. Please note that `rete-angular-plugin` is only compatible with Angular applications.
1819

content/en/docs/4.guides/1.basic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ keywords: basic,area,core
66
# Basic editor
77

88
::alert
9-
This guide features the `rete-react-plugin`. You can use it in any application, regardless of the framework you're using (**React.js**, **Vue.js**, **Angular** or **Svelte**).
9+
This guide features the `rete-react-plugin`. You can use it in any application, regardless of the framework you're using (**React.js**, **Vue.js**, **Angular**, **Svelte** etc.).
1010

11-
Follow this guide to use the corresponding render plugin in your **Angular**, **Svelte** or **Vue.js** application, with reference to the respective guides for [Angular](/docs/guides/renderers/angular), [Svelte](/docs/guides/renderers/svelte) or [Vue.js](/docs/guides/renderers/vue)
11+
Follow this guide to use the corresponding render plugin in your **Angular**, **Svelte** or **Vue.js** application, with reference to the respective guides for [Angular](/docs/guides/renderers/angular), [Svelte](/docs/guides/renderers/svelte), [Vue.js](/docs/guides/renderers/vue) etc.
1212
::
1313

1414
::references

content/en/docs/4.guides/10.minimap.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,16 @@ But this is not sufficient as the render plugin is responsible for visualization
5252

5353
## Rendering the minimap {#render}
5454

55-
Currently, the visualization of the minimap is possible using rendering plugins for **React.js**, **Vue.js**, **Angular** and **Svelte**
55+
Currently, the visualization of the minimap is possible using rendering plugins for **React.js**, **Vue.js**, **Angular**, **Svelte** and **Lit**.
5656

5757
```ts
58-
import { Presets } from "rete-react-plugin"; // or rete-vue-plugin, rete-angular-plugin, rete-svelte-plugin
58+
import { Presets } from "rete-react-plugin"; // or rete-vue-plugin, rete-angular-plugin, rete-svelte-plugin, @retejs/lit-plugin
5959

6060
render.addPreset(Presets.minimap.setup({ size: 200 }));
6161
```
6262

6363
For a comprehensive guide on how to connect a specific renderer plugin to your stack version, please follow the guide for
64-
[React.js](/docs/guides/renderers/react), [Vue.js](/docs/guides/renderers/vue), [Angular](/docs/guides/renderers/angular) or [Svelte](/docs/guides/renderers/svelte)
64+
[React.js](/docs/guides/renderers/react), [Vue.js](/docs/guides/renderers/vue), [Angular](/docs/guides/renderers/angular), [Svelte](/docs/guides/renderers/svelte) or [Lit](/docs/guides/renderers/lit)
6565

6666
The minimap is automatically inserted into your editor and has absolute positioning. If your editor is smaller than the viewport, your editor's container should have `position: relative`.
6767

content/en/docs/4.guides/13.reroute.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ The plugin is connected, but you need also connect a visualization preset to ren
4040

4141
## Rendering {#rendering}
4242

43-
Currently, the visualization of the reroute pins is possible using rendering plugins for **React.js**, **Vue.js**, **Angular** and **Svelte**
43+
Currently, the visualization of the reroute pins is possible using rendering plugins for **React.js**, **Vue.js**, **Angular**, **Svelte** and **Lit**.
4444

4545
```ts
46-
import { Presets } from "rete-react-plugin"; // or rete-vue-plugin, rete-angular-plugin, rete-svelte-plugin
46+
import { Presets } from "rete-react-plugin"; // or rete-vue-plugin, rete-angular-plugin, rete-svelte-plugin, @retejs/lit-plugin
4747

4848
render.addPreset(Presets.reroute.setup({
4949
contextMenu(id) {
@@ -56,7 +56,7 @@ render.addPreset(Presets.reroute.setup({
5656
```
5757

5858
For a comprehensive guide on how to connect a specific renderer plugin to your stack version, please follow the guide for
59-
[React.js](/docs/guides/renderers/react), [Vue.js](/docs/guides/renderers/vue), [Angular](/docs/guides/renderers/angular) or [Svelte](/docs/guides/renderers/svelte)
59+
[React.js](/docs/guides/renderers/react), [Vue.js](/docs/guides/renderers/vue), [Angular](/docs/guides/renderers/angular), [Svelte](/docs/guides/renderers/svelte) or [Lit](/docs/guides/renderers/lit)
6060

6161
## Selectable Pins {#selectable}
6262

0 commit comments

Comments
 (0)