durbok/noodl-docs
1
0
Fork 0
mirror of https://github.com/noodlapp/noodl-docs.git synced 2026-01-11 14:52: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

12
nodes/events/receive-event/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Receive Event node
---
<##head##>
{/*##head##*/}
# Receive Event
@@ -17,15 +17,15 @@ This node is used to receive a signal triggered by a <span className="ndl-node">
</div>
The <span className="ndl-node">Send Event</span> node lets you specify a channel to broadcast to. All <span className="ndl-node">Receive Event</span> nodes set to that channel will be triggered simultaneously.
<##head##>
{/*##head##*/}
## Inputs
| Data | Description |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Enabled</span> | <##input:enabled##>This port is used to disable/enable this node.<##input##> If disabled the receiver node will not be activated when the corresponding [Send Event](/nodes/events/send-event) node is triggered. |
| <span className="ndl-data">Consume</span> | <##input:consume##>This property specified if and how the event is consumed when captured by this receive event node.<##input##> |
| <span className="ndl-data">Channel</span> | <##input:channelName##>Each **Receive Event** node must listen to a specific channel.<##input##> This means that when a [Send Event][/nodes/events/send-event] node of that channel is triggered all **Receive Event** nodes with the same channel will be triggered as well (depending on the propagation, please review the [Events guide](/docs/guides/business-logic/events) for more details). |
| <span className="ndl-data">Enabled</span> | {/*##input:enabled##*/}This port is used to disable/enable this node.{/*##input##*/} If disabled the receiver node will not be activated when the corresponding [Send Event](/nodes/events/send-event) node is triggered. |
| <span className="ndl-data">Consume</span> | {/*##input:consume##*/}This property specified if and how the event is consumed when captured by this receive event node.{/*##input##*/} |
| <span className="ndl-data">Channel</span> | {/*##input:channelName##*/}Each **Receive Event** node must listen to a specific channel.{/*##input##*/} This means that when a [Send Event][/nodes/events/send-event] node of that channel is triggered all **Receive Event** nodes with the same channel will be triggered as well (depending on the propagation, please review the [Events guide](/docs/guides/business-logic/events) for more details). |
## Outputs
@@ -35,4 +35,4 @@ The <span className="ndl-node">Send Event</span> node lets you specify a channel
| Signal | Description |
| -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Received</span> | <##output:eventReceived##>This is a signal port, it is triggered when a signal is triggered in any **Send Event** node with the same channel as this **Receive Event** node.<##output##> |
| <span className="ndl-signal">Received</span> | {/*##output:eventReceived##*/}This is a signal port, it is triggered when a signal is triggered in any **Send Event** node with the same channel as this **Receive Event** node.{/*##output##*/} |

8
nodes/events/send-event/README.md
View File

@@ -4,7 +4,7 @@ hide_table_of_contents: true
title: Send Event node
---
<##head##>
{/*##head##*/}
# Send Event
@@ -17,7 +17,7 @@ This node sends a <span className="ndl-signal">signal</span> to another place in
</div>
The <span className="ndl-node">Send Event</span> node lets you specify a channel to broadcast to. When this node is triggered with a <span className="ndl-signal">Send signal</span> all <span className="ndl-node">Receive Event</span> nodes set to that channel will be triggered.
<##head##>
{/*##head##*/}
## Inputs
@@ -28,8 +28,8 @@ The <span className="ndl-node">Send Event</span> node lets you specify a channel
| Data | Description |
| ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-data">Channel Name</span> | The channel name can be any identifier and is used on the [Receive Event](/nodes/events/receive-event) nodes to connect a sender and receiver node.<br/><br/>There may be multiple **Send Event** nodes with the same channel. In that case the receiving nodes listening to the channel will get a merged set of ports from all **Send Event** nodes. |
| <span className="ndl-data">Send To</span> | <##input:propagation##>Controls what components the event will be sent to.<##input##><br/><br/>`Global`: Send to all components<br/>`Parent`: Send the event up the visual hierarchy to parent components.<br/>`Children`: Send the events to all children of this component, and their descendants.<br/>`Siblings`: Send the event to all siblings of this component in the visual hierarchy. |
| <span className="ndl-data">Send To</span> | {/*##input:propagation##*/}Controls what components the event will be sent to.{/*##input##*/}<br/><br/>`Global`: Send to all components<br/>`Parent`: Send the event up the visual hierarchy to parent components.<br/>`Children`: Send the events to all children of this component, and their descendants.<br/>`Siblings`: Send the event to all siblings of this component in the visual hierarchy. |
| Signal | Description |
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <span className="ndl-signal">Send Event</span> | <##input:sendEvent##>Send a signal to this input to send the event.<##input##> This is a signal port and when triggered the corresponding [Receive Event](/nodes/events/receive-event) nodes will be triggered as well. |
| <span className="ndl-signal">Send Event</span> | {/*##input:sendEvent##*/}Send a signal to this input to send the event.{/*##input##*/} This is a signal port and when triggered the corresponding [Receive Event](/nodes/events/receive-event) nodes will be triggered as well. |