durbok/noodl-docs
1
0
Fork 0
mirror of https://github.com/noodlapp/noodl-docs.git synced 2026-01-11 23:02:54 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: Upgrade Docusaurus from v2 to v3 (#52)

Browse Source 
* chore: Upgrade Docusaurus from v2 to v3

* chore: Update "Test build" GH workflow

* fix: build

All markdown is processed as MDX

* fix: Broken links
This commit is contained in:
Eric Tuvesson
2024-01-12 16:53:22 +01:00
committed by GitHub
parent 65b0cf0417
commit 656e5fc8d2
156 changed files with 4854 additions and 10445 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
nodes/utilities/boolean-to-string/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Boolean To String node
---
<##head##>
{/*##head##*/}
# Boolean To String
@@ -16,22 +16,22 @@ This node takes a <span className="ndl-data">boolean</span> input and converts i
</div>
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Selector</span> | <##input:selector##>This is the boolean value that will select which string to output.<##input##> |
| <span className="ndl-data">String for true</span> | <##input:trueString##>The string to output if the selector is true.<##input##> |
| <span className="ndl-data">String for false</span> | <##input:falseString##>The string to output if the selecor is false.<##input##> |
| <span className="ndl-data">Selector</span> | {/*##input:selector##*/}This is the boolean value that will select which string to output.{/*##input##*/} |
| <span className="ndl-data">String for true</span> | {/*##input:trueString##*/}The string to output if the selector is true.{/*##input##*/} |
| <span className="ndl-data">String for false</span> | {/*##input:falseString##*/}The string to output if the selecor is false.{/*##input##*/} |
## Outputs
| Data | Description |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| <span className="ndl-data">Current Value</span> | <##output:currentValue##>The selected string, i.e. either **String for true** or **String for false** depending on the **Selector**.<##output##> |
| <span className="ndl-data">Current Value</span> | {/*##output:currentValue##*/}The selected string, i.e. either **String for true** or **String for false** depending on the **Selector**.{/*##output##*/} |
| Signal | Description |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Selector Changed</span> | <##output:inputChanged##>This signal is sent when the **Selector** changes value.<##output##> |
| <span className="ndl-signal">Selector Changed</span> | {/*##output:inputChanged##*/}This signal is sent when the **Selector** changes value.{/*##output##*/} |

4
nodes/utilities/color-blend/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Color Blend node
---
<##head##>
{/*##head##*/}
# Color Blend
@@ -16,7 +16,7 @@ This node lets you blend between color values.
</div>
<##head##>
{/*##head##*/}
## Inputs

4
nodes/utilities/css-definition/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: CSS Definition node
---
<##head##>
{/*##head##*/}
# CSS Definition
@@ -34,4 +34,4 @@ Classes can be attached to the Visual nodes in the Property Panel:
The CSS Definition is best used if a style class will be reused on multiple different Visual nodes. If you're only styling one Visual node you should do it in the CSS Style editor at the bottom of the Property Panel.
<##head##>
{/*##head##*/}

20
nodes/utilities/date-to-string/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Date To String node
---
<##head##>
{/*##head##*/}
# Date To String
@@ -18,15 +18,15 @@ This node translates a <span className="ndl-data">date</span> type input and out
The format is specified as a <span className="ndl-data">string</span> that can include the following special syntax: `{date}`, `{month}`, `{monthShort}`, `{year}`, `{hours}`, `{minutes}` and `{seconds}`.
<##head##>
{/*##head##*/}
- **{date}** The numeric date part.
- **{month}** The numeric month 1 = January, 12 = December.
- **{monthShort}** The numeric month 1 = Jan, 12 = Dec.
- **{year}** The numeric year.
- **{hours}** The numeric hour, between 0..23
- **{minutes}** The numeric minute, between 0..60
- **{seconds}** The numeric second, between 0..60
- `{date}` The numeric date part.
- `{month}` The numeric month 1 = January, 12 = December.
- `{monthShort}` The numeric month 1 = Jan, 12 = Dec.
- `{year}` The numeric year.
- `{hours}` The numeric hour, between 0..23
- `{minutes}` The numeric minute, between 0..60
- `{seconds}` The numeric second, between 0..60
The default format is this:
@@ -57,4 +57,4 @@ The default format is this:
| ------------------------------------------------ | ------------------------------------------------------ |
| <span className="ndl-signal">Date Changed</span> | Sends a signal when the formatted date string changed. |
</div>
</div>

4
nodes/utilities/delay/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Delay node
---
<##head##>
{/*##head##*/}
# Delay
@@ -16,7 +16,7 @@ This node lets you delay <span className="ndl-signal">signals</span> by the spec
</div>
<##head##>
{/*##head##*/}
## Inputs

4
nodes/utilities/drag/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Drag node
---
<##head##>
{/*##head##*/}
# Drag
@@ -22,7 +22,7 @@ The Drag node can only have one child, but that child can have many children.
</div>
<##head##>
{/*##head##*/}
## Inputs

16
nodes/utilities/logic/condition/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Condition node
---
<##head##>
{/*##head##*/}
# Condition
@@ -18,7 +18,7 @@ This node evaluates a condition and sends one of two <span className="ndl-signal
The input <span className="ndl-data">Condition</span> will be treated as a <span className="ndl-data">boolean</span>, and the evaluation happens when the input changes, unless an explict <span className="ndl-signal">signal</span> is connected to the <span className="ndl-signal">Evaluate</span> input.
<##head##>
{/*##head##*/}
<div className="ndl-image-with-background l">
@@ -30,20 +30,20 @@ The input <span className="ndl-data">Condition</span> will be treated as a <span
| Data | Description |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Condition</span> | <##input:condition##>A boolean that decides which output signal (**On true** or **On false**) that should be triggered when the **Evaluate** signal is triggered or when the condition changes, if the **Evaluate** signal is not connected.<##input##> |
| <span className="ndl-data">Condition</span> | {/*##input:condition##*/}A boolean that decides which output signal (**On true** or **On false**) that should be triggered when the **Evaluate** signal is triggered or when the condition changes, if the **Evaluate** signal is not connected.{/*##input##*/} |
| Signal | Description |
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Evaluate</span> | <##input:evaluate##>Evaluates the **Condition** input and triggers the respective output signal. If no signal is connected to Evaluate, the node will evaluate the input everytime the input changes.<##input##> |
| <span className="ndl-signal">Evaluate</span> | {/*##input:evaluate##*/}Evaluates the **Condition** input and triggers the respective output signal. If no signal is connected to Evaluate, the node will evaluate the input everytime the input changes.{/*##input##*/} |
## Outputs
| Data | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Is True</span> | <##output:result##>A <span className="ndl-data">boolean</span> that is <span className="ndl-data">true</span> when the latest evaluated value on the **Condition** input is true. <##output##> |
| <span className="ndl-data">Is False</span> | <##output:isfalse##>A <span className="ndl-data">boolean</span> that is <span className="ndl-data">false</span> when the latest evaluated value on the **Condition** input is false. <##output##> |
| <span className="ndl-data">Is True</span> | {/*##output:result##*/}A <span className="ndl-data">boolean</span> that is <span className="ndl-data">true</span> when the latest evaluated value on the **Condition** input is true. {/*##output##*/} |
| <span className="ndl-data">Is False</span> | {/*##output:isfalse##*/}A <span className="ndl-data">boolean</span> that is <span className="ndl-data">false</span> when the latest evaluated value on the **Condition** input is false. {/*##output##*/} |
| Signal | Description |
| -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">On True</span> | <##output:ontrue##>Triggered when **Evaluate** is triggered and **Condition** is <span className="ndl-data">true.</span><##output##> |
| <span className="ndl-signal">On False</span> | <##output:onfalse##>Triggered when **Evaluate** is triggered and **Condition** is <span className="ndl-data">false.</span><##output##> |
| <span className="ndl-signal">On True</span> | {/*##output:ontrue##*/}Triggered when **Evaluate** is triggered and **Condition** is <span className="ndl-data">true.</span>{/*##output##*/} |
| <span className="ndl-signal">On False</span> | {/*##output:onfalse##*/}Triggered when **Evaluate** is triggered and **Condition** is <span className="ndl-data">false.</span>{/*##output##*/} |

24
nodes/utilities/logic/states/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: States node
---
<##head##>
{/*##head##*/}
# States
@@ -24,7 +24,7 @@ The <span className="ndl-node">State</span> node is often used to create animati
</div>
<##head##>
{/*##head##*/}
To learn more take a look at the [States guide](/docs/guides/user-interfaces/states).
@@ -34,12 +34,12 @@ To learn more take a look at the [States guide](/docs/guides/user-interfaces/sta
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">States</span> | A **States** node can have as many states as is necessary. Add a new state by clicking on the plus button. |
| <span className="ndl-data">Values</span> | Every state will have its own set of values. All values need to be set for every state that is added. |
| <span className="ndl-data">State</span> | <##input:state##>This input controls the current state. By setting this input to the same name as one of the available states, **State** node will change to that state.<##input##> |
| <span className="ndl-data">Use Transitions</span> | <##input:useTransitions##>Setting this to <span className="ndl-data">true</span> will turn on transitions when moving between states, while <span className="ndl-data">false</span> will turn them off. <##input##> |
| <span className="ndl-data">State</span> | {/*##input:state##*/}This input controls the current state. By setting this input to the same name as one of the available states, **State** node will change to that state.{/*##input##*/} |
| <span className="ndl-data">Use Transitions</span> | {/*##input:useTransitions##*/}Setting this to <span className="ndl-data">true</span> will turn on transitions when moving between states, while <span className="ndl-data">false</span> will turn them off. {/*##input##*/} |
| Signal | Description |
| ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Toggle</span> | <##input:toggle##>Triggering this signal will force the **State** node to move to the next state in its state list, or the first state if the current state is the last one.<##input##> |
| <span className="ndl-signal">Toggle</span> | {/*##input:toggle##*/}Triggering this signal will force the **State** node to move to the next state in its state list, or the first state if the current state is the last one.{/*##input##*/} |
### Value types
@@ -53,7 +53,7 @@ For each value you can specify the type. Default is **Number**.
For every state you can specify each of the values. This is the value that they will have when you are at that specific state. You can also set the values for each state by connecting them to other nodes.
<span className="hidden-props-for-editor"><##input:.\*##>The value of a property for a specific state.<##input##></span>
<span className="hidden-props-for-editor">{/*##input:.\*##*/}The value of a property for a specific state.{/*##input##*/}</span>
<div className="ndl-image-with-background">
<img src="/nodes/animation/state-values.png" className="ndl-image small"></img>
@@ -73,22 +73,22 @@ To learn more take a look at the [States guide](/docs/guides/user-interfaces/sta
Each state will have a signal input called **To** followed by the state name. This can be used to connect a signal that will take the states node to that state when the signal is triggered.
<span className="hidden-props-for-editor"><##input:to-\*##>Triggers the **State** node to move to this state.<##input##></span>
<span className="hidden-props-for-editor">{/*##input:to-\*##*/}Triggers the **State** node to move to this state.{/*##input##*/}</span>
## Outputs
| Data | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------- |
| <span className="ndl-data">State</span> | <##output:state##>The name of the current state.<##output##> |
| <span className="ndl-data">State</span> | {/*##output:state##*/}The name of the current state.{/*##output##*/} |
| <span className="ndl-data">Values</span> | All of the values for the current state and for any transitions that is active. |
<span className="hidden-props-for-editor"><##output:.\*##>The value of the property, given the current state and transition.<##output##></span>
<span className="hidden-props-for-editor">{/*##output:.\*##*/}The value of the property, given the current state and transition.{/*##output##*/}</span>
| Signal | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">State Changed</span> | <##output:stateChanged##>A signal that is sent when the current state is changed.<##output##> |
| <span className="ndl-signal">State Changed</span> | {/*##output:stateChanged##*/}A signal that is sent when the current state is changed.{/*##output##*/} |
| <span className="ndl-signal">At `[State Name]`</span> | True when the currently selected state is `[State Name]`. For example, if the _State_ node has a state _Started_, it will have an output signal called _At Started_. |
| <span className="ndl-signal">Has Reached `[State Name]`</span> | Signal sent when the state animation to state `[State Name]` is complete. |
<span className="hidden-props-for-editor"><##output:at-\*##>This value is <span className="ndl-data">true</span> when this state is active, otherwise <span className="ndl-data">false</span>.<##output##></span>
<span className="hidden-props-for-editor"><##output:reached-\*##>This signal is sent when the specific state has been reached.<##output##></span>
<span className="hidden-props-for-editor">{/*##output:at-\*##*/}This value is <span className="ndl-data">true</span> when this state is active, otherwise <span className="ndl-data">false</span>.{/*##output##*/}</span>
<span className="hidden-props-for-editor">{/*##output:reached-\*##*/}This signal is sent when the specific state has been reached.{/*##output##*/}</span>

20
nodes/utilities/open-file-picker/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Open File Picker node
---
<##head##>
{/*##head##*/}
# Open File Picker
@@ -18,33 +18,33 @@ This node opens a file picker dialog. Noodl uses the system file picker dialog,
You can define what file types are allowed to be uploaded. This is done by entering a <span className="ndl-data">string</span> of file types: each item needs to start with a period (`.`) and be separated by a comma (`,`). Leave the list blank if you want to accept any file type.
<##head##>
{/*##head##*/}
## Inputs
| Signal | Description |
| ---------------------------------------- | ------------------------------------------------------------------------------- |
| <span className="ndl-signal">Open</span> | <##input:open##>Send a signal to this input to open the file picker.<##input##> |
| <span className="ndl-signal">Open</span> | {/*##input:open##*/}Send a signal to this input to open the file picker.{/*##input##*/} |
| Data | Description |
| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Accepted file types</span> | <##input:accepted file types##>A comma separated list of file types that the user can select. Leave blank to accept any file type.<##input##><br/><br/>The file type can be specified as a filename extension, starting with a period. E.g. `.png`, `.json` or `.png, .jpg`.<br/><br/>The type can also be specified as a [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). E.g. `image/*`, `image/png` or `video/mp4`. |
| <span className="ndl-data">Accepted file types</span> | {/*##input:accepted file types##*/}A comma separated list of file types that the user can select. Leave blank to accept any file type.{/*##input##*/}<br/><br/>The file type can be specified as a filename extension, starting with a period. E.g. `.png`, `.json` or `.png, .jpg`.<br/><br/>The type can also be specified as a [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types). E.g. `image/*`, `image/png` or `video/mp4`. |
## Outputs
| Data | Description |
| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">File</span> | <##output:file##>A web file API Object.<##output##> A [File](https://developer.mozilla.org/en-US/docs/Web/API/File) object. This can be used uploaded via [Upload File](/nodes/data/cloud-data/upload-file), sent as a part of a [REST](/nodes/data/rest) call, processed in a [Function](/nodes/javascript/function) node, used together with modules, or other tasks. |
| <span className="ndl-data">File</span> | {/*##output:file##*/}A web file API Object.{/*##output##*/} A [File](https://developer.mozilla.org/en-US/docs/Web/API/File) object. This can be used uploaded via [Upload File](/nodes/data/cloud-data/upload-file), sent as a part of a [REST](/nodes/data/rest) call, processed in a [Function](/nodes/javascript/function) node, used together with modules, or other tasks. |
### Metadata
| Data | Description |
| ----------------------------------------------- | ---------------------------------------------------------------------- |
| <span className="ndl-data">Path</span> | <##output:path##>The local path to the file.<##output##> |
| <span className="ndl-data">Name</span> | <##output:name##>Name of the file, without the path.<##output##> |
| <span className="ndl-data">Size in bytes</span> | <##output:size in bytes##>Total size of the file in bytes.<##output##> |
| <span className="ndl-data">Type</span> | <##output:type##>The file type<##output##> |
| <span className="ndl-data">Path</span> | {/*##output:path##*/}The local path to the file.{/*##output##*/} |
| <span className="ndl-data">Name</span> | {/*##output:name##*/}Name of the file, without the path.{/*##output##*/} |
| <span className="ndl-data">Size in bytes</span> | {/*##output:size in bytes##*/}Total size of the file in bytes.{/*##output##*/} |
| <span className="ndl-data">Type</span> | {/*##output:type##*/}The file type{/*##output##*/} |
| Signal | Description |
| ------------------------------------------- | --------------------------------------------------------------------------- |
| <span className="ndl-signal">Success</span> | <##output:success##>Triggered when the user has selected a file<##output##> |
| <span className="ndl-signal">Success</span> | {/*##output:success##*/}Triggered when the user has selected a file{/*##output##*/} |

4
nodes/utilities/screen-resolution/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Screen Resolution node
---
<##head##>
{/*##head##*/}
# Screen Resolution
@@ -16,7 +16,7 @@ This node outputs the <span className="ndl-data">width</span>, <span className="
</div>
<##head##>
{/*##head##*/}
## Outputs

4
nodes/utilities/unique-id/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Unique Id node
---
<##head##>
{/*##head##*/}
# Unique Id
@@ -18,7 +18,7 @@ This node generates a unique ID, something that is very useful when storing data
Generating a unique ID for every entity in the database means that it can easily be retrieved and referenced, no matter what the content is.
<##head##>
{/*##head##*/}
## Inputs