Skip to content

Latest commit

 

History

History
265 lines (184 loc) · 23.2 KB

README.md

File metadata and controls

265 lines (184 loc) · 23.2 KB
Raw

Discussion Static Badge NPM Version NPM Total Downloads NPM Downloads per month GitHub last commit GitHub stars GitHub watchers GitHub license Min Node Version Package Quality DeepScan grade CodeQL Open Issues Closed Issues

node-red-contrib-uibuilder

UIBUILDER for Node-RED allows the easy creation of data-driven front-end web applications.

It includes many helper features that can reduce or eliminate the need to write code for building data-driven web applications and user interfaces integrated with Node-RED.

Note

UIBUILDER triggers a quality warning in the Flows scorecard entry.

"Number of Dependencies" is >6 - this is due to the large number of features in UIBUILDER and is expected. Even so, v7 only has 7 dependencies. 1 more is due to be removed in a future release.

Installation

UIBUILDER is best installed using Node-RED's Palette Manager.

Manual installs and other versions

To install manually, from a command line on your Node-RED server:

cd ~/.node-red
npm install node-red-contrib-uibuilder

To install old versions, provide the major version number:

cd ~/.node-red
npm install node-red-contrib-uibuilder@v5

To install development branches, please install from GitHub. Branchnames are future version numbers, check GitHub for available branches:

cd ~/.node-red
npm install totallyinformation/node-red-contrib-uibuilder#v7.1.0

You will need to restart Node-RED if installing manually.

Updates

The current CHANGELOG contains all of the changes and requirement details for each version.

Older changes can be found in the previous change documents: CHANGELOG-V5, CHANGELOG-V5, CHANGELOG-V3/V4, CHANGELOG-v2, and CHANGELOG-v2.

Getting started

Once installed, The following is a typical simple flow to get going.

  1. Add a uibuilder node. Open its settings and give it a "URL" which is used as the identifying name. Close the settings and click on the Deploy button.
  2. Re-open the uibuilder node's settings and click the "Open" button to see the resulting web page.

You are now ready to edit the front-end html/javascript/css if you wish and to add logic in Node-RED to provide inputs and handle outputs. You can also use UIBUILDER's no-code features to create your UI as well or instead.

Please see the First-timers walkthrough in the documentation and the Introduction Video for more help to get started. Also try out the built-in example flows.

Examples

Within Node-RED, use the hamburger menu. Click Import. Click Examples. Select the node-red-contrib-uibuilder folder and choose an example.

The templates feature in UIBUILDER provides working front-end code of various configurations.

Other examples can be found on the Node-RED Flows site and the UIBUILDER WIKI. Also see the FAQ's and answered questions on the Node-RED Forum.

Documentation and other links

Please refer to the Documentation web site. This can also be accessed from within UIBUILDER nodes even without an Internet connection.

There is a library of "official" video tutorials on YouTube. Other folk have also produced UIBUILDER-related content.

Questions, issues and suggestions

The best place to ask questions or discuss possible enhancements is the Node-RED Forum.

Alternatively, use the GitHub issues log for raising issues or contributing suggestions and enhancements and the GitHub Discussions page for general questions, suggestions, etc.

Other links

Purpose

The purpose of UIBUILDER is to:

  • Support easy methods for creating and delivering data-driven web apps and web pages (also known as web User-Interfaces).
  • Be a conduit between Node-RED and front-end (browser) UI web apps.
  • Be UI framework agnostic. No framework is needed to use UIBUILDER but it will work with them where desired. UIBUILDER aims to reduce the requirement for a framework by making it easier to work with vanilla HTML/CSS.
  • Provide interface/data standards for exchanging data and controls between Node-RED and the web pages.
  • Enable the creation and management of multiple web apps from a single Node-RED instance.
  • Reduce the amount of front-end code (HTML/JavaScript) needed to create and manage a web app.
  • Reduce the knowledge required for creating reliable, accessible web apps by providing low-code and no-code features.
  • Make it easy to install and serve front-end libraries to support the development of more complex web apps.

Features

The core features of UIBUILDER:

  • As far as possible, uses only vanilla, native HTML, CSS and JavaScript. Other than the Socket.IO client for communications (which is baked into the front-end library), no other front-end libraries are needed. UIBUILDER stays as close as possible to native HTML to avoid future compatibility issues. However, it does aim to make interaction with native HTML easier.
  • Nodes to enable zero-code translation of input data to usable and accessible web elements.
  • Capability for low-code, configuration-driven (data-driven) UI's. Creating a framework for describing a UI and translating to actual code without having to write code.
  • 2-way communications channel between the Node-RED server (back-end) and front-end UI.
  • A Node-RED node to act as the focus for communications with other nodes for additional ease of use.
  • Front-end library to: do the complex parts of the communications in the client browser; make manipulation of the UI easier and more consistent; make it easy to get data back to Node-RED as needed (both automatically and manually).
  • Easy to use templates and examples for front-end code to enable people to get a quick start on creating web apps.
  • Management and serving of npm packages that provide front-end libraries consumable easily by front-end code.
  • Editing of front-end code from the Node-RED Editor (designed for small changes, use web development tools generally).
  • Various server middleware and API options for additional custom capabilities.
  • A caching capability allowing newly joining clients to receive the latest data and configurations. Joining/leaving clients create notifications in Node-RED.
  • A front-end lightweight router for creating Single-Page Apps.
  • Have as many uibuilder node instances as you like. Each instance allows the creation of many web pages and sub-folders for easy management.
  • Each uibuilder node instance provides a private 2-way communications channel between the Node-RED server (back-end) and browser (front-end) UI code.
  • Supports the use of standard web development workflows.
  • Allows the creation of a dedicated web service to facilitate independent security.
No-code UI's

UIBUILDER continues to expand its no-code capabilities. THe uib-element, uib-tag, and uib-update nodes offer no-code methods for creating and updating data-driven web UI's.

uib-element takes in simple data and outputs configuration data. This can then be sent to the front-end via the uibuilder node. Alternatively, it can be saved and the result used in an initial load. Several simple options such as tables and lists are available in UIBUILDER v6.1, additional elements and structures will be made available in future versions. The UIBUILDER front-end client takes the configuration information and dynamically builds HTML elements and inserts them to the web page (or removes/updates as needed).

While this is not the most efficient processing approach (since updates are mostly replacing the whole element which could be quite large for things like big tables), it is very efficient from an authoring perspective. So the uib-update node provides a more targetted approach to updating and changing specific attributes and "slot" content for elements.

The uib-tag node then lets you create ANY single HTML element and so covers all the many things that uib-element might not (yet) cover. This even works with web components which are vanilla HTML/JavaScript native enhancements to HTML.

It is important to note that no front-end, 3rd-party frameworks such as VueJS or REACT are needed for this approach! Everything uses vanilla HTML, JavaScript and CSS under the skin and so is compatible with current and future web standards.

Low-code UI's

The data that uib-element outputs is a format that you can use in your own flows in Node-RED and even in front-end code if desired. It describes a set of HTML UI elements but does not need you to actually write HTML code. The configuration schema is very flexible and even allows you to load configuration data, HTML, scripts, and new ECMA Modules/Components from external files.

The schema and the UI creator functions built into the front-end client are specifically designed to work with current and future HTML standards in order to avoid the kinds of issues commonly encountered when using 3rd-party front-end frameworks (e.g. major version changes forcing rewrites of all of your tooling). So ES Modules, ECMA Components, and future ECMA versions should all be supported.

The ui.js library is now also available for anyone to use in their own projects and works fully stand-alone without UIBUILDER. It is also baked into the uib-html node which turns low-code configurations into HTML from within Node-RED.

Future direction

UIBUILDER will continue to be independent of front-end frameworks though it will also continue to be as compatible as possible so that any desired framework can be used with it.

  • It will continue to gain more zero-code pre-built elements.
  • It will gain improved control over the instance root folder structure and the ability to execute npm run scripts defined in the package.json.
  • More videos!

Longer term focus

There remains a desire to build a page-builder feature so that people with no coding skills can build great data-driven web apps.

  • The documentation quality will continue to improve.
  • The number of 3rd-party module dependencies will be reduced. Starting with the eventual removal of fs-extra in favour of the native promisified fs library. Followed most likely by arun.
  • Once Node.js v18 or 20 is the base, the code is likely to be refactored into multiple sub-packages in a mono-repo.
Feature details and benefits
  • Designed as an alternative to the Node-RED official Dashboard. Without the overheads and restrictions.
  • Control everything from the Node-RED admin ui. Edit your front-end resource files, manage front-end packages. No need to access the servers command line.
  • Manage startup templates. Internal templates for vanilla HTML, Svelte, VueJS (v2 & v3), and VueJS/bootstrap-vue are provided. Load templates from other repositories via degit. Makes it easy to share templates that provide a whole app or just deal with boilerplate.
  • Have as many custom user interfaces as you want. Just 1 node is needed for each entry point. Use link nodes to send data from other parts of your flows. An entry point can be contain multiple web pages.
  • Has a control interface separate to the message interface. Know when a browser tab connects or disconnects, send cached data, and more.
  • Provide a stable client id that identifies a specific browser profile until it is restarted. A tabId is provided that identifies a specific browser tab on a client device.
  • Provide information to Node-RED about the client that is sending a msg so that security and other processing can identify the client, the user, and so on.
  • Can be a lot lighter in weight and more mobile friendly than the Node-RED official Dashboard.
  • Use any front-end framework you like. Simply install via the built-in library manager.
  • Use without any front-end framework if you prefer. Keep it light and simple. Try this out with the "Blank" template and the uib-element node.
  • The included front-end libraries (uibuilder.iife.js, uibuilder.esm.js) provide connectivity to Node-RED and msg event handling along with some helper utility functions.
  • Write your own HTML, CSS and JavaScript to define the perfect front-end user interface for your needs. Or define it using a JSON config description.
  • Edit your custom front-end code from within the Node-RED Editor. Auto-reload your clients on changes to the code. Great for rapid development. Note that this is designed for quick edits, it is recommended to use your normal web development toolchain for larger edits.
  • Needs almost no boilerplate in your front-end code in order to work.
  • Optional index web page listing of available files.
  • Two detailed admin info web pages are included to help authors understand where everything is and what is available.
  • Uses Node-RED's own ExpressJS webservers by default. Switch to a custom ExpressJS server if desired. When using a custom server, pages can also include EJB server-side templating.
  • Has middleware for ExpressJS (for web services) and Socket.IO (for communications, both at initial connection and per-message) so that you can add your own custom features including security.
  • Can create custom API's for each UIBUILDER instance.
  • Use the ui.js library in your own projects!

Contributing

If you would like to contribute to this node, you can contact Totally Information via GitHub or raise a request in the GitHub issues log.

Pull Requests both for code and documentation are welcomed and the WIKI is open to new entries and corrections (but please let me know if you make a change).

Please refer to the contributing guidelines for more information.

You can also support the development of UIBUILDER by sponsoring the development.

ko-fi

GitHub Sponsorship, PayPal Sponsorship

Sponsors

Developers/Contributors

Many other people have contributed ideas and suggestions, thanks to everyone who does, they are most welcome.

profile for Julian Knight on Stack Exchange, a network of free, community-driven Q&A sites

Please also check out my blog, Much Ado About IT, it has information about all sorts of topics, mainly IT related, including Node-RED.