docs • creating nodes • examples

Example flows

A packaged node can provide simple example flows that demonstrate how it can be used.

They will appear under the Examples section of the library import menu.

Ideally they should be short, have a comment node to describe the functionality, and not use any other 3rd party nodes that need to be installed.

To create an example, add a flow file to an examples directory in your node package. See Packaging for more details.

The name of the flow file will be the menu entry displayed in the menu list. For example:

examples\My Great Example.json

will display as

My Great Example

Node-RED: Low-code programming for event-driven applications.

Copyright OpenJS Foundation and Node-RED contributors. All rights reserved. The OpenJS Foundation has registered trademarks and uses trademarks. For a list of trademarks of the OpenJS Foundation, please see our Trademark Policy and Trademark List. Trademarks and logos not indicated on the list of OpenJS Foundation trademarks are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.