Registry / devops / node-red-node-ui-list

node-red-node-ui-list

library0.3.6jsnpmunverified

A Node-RED Dashboard widget node for displaying a list of items with support for titles, descriptions, icons (URL, Font Awesome, or unicode), and multiple interaction modes (none, click, checkbox, switch, menu). Current stable version is 0.3.6. It pairs with Node-RED Dashboard 2.15+ and Node-RED 0.19+. Unlike custom dashboard widgets, this node is officially maintained by the Node-RED team and integrates seamlessly with the Dashboard 2.0 UI framework. It supports both simple string arrays and complex objects, with optional HTML rendering. Release cadence is sporadic with minor patch updates.

devops

npm install node-red-node-ui-list

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NODE-RED-NODE-UI-L

node-red-node-ui-list

devopsjavascriptv0.3.6

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ui_list

✓ npm install node-red-node-ui-list

✗ npm install node-red-node-ui-list --save-dev

The node is installed as a regular dependency in the Node-RED user directory (~/.node-red) using npm, not as a devDependency. It is not imported via JavaScript; it appears as a palette node after installation.

Shows installation command and a minimal flow snippet demonstrating the ui_list node configuration and expected input payload.

// This node is used via Node-RED flow editor, not via code. // To use it, install the package and add the ui-list node from the palette. // Example flow JSON: [ { "id": "93612884.34d35", "type": "ui_list", "z": "ee47c5e8.e17bd", "group": "7e4c65d6.0419cc", "name": "", "order": 1, "width": "6", "height": "5", "lineType": "three", "actionType": "click", "allowHTML": true, "x": 290, "y": 100, "wires": [["cd592928.56da38"]] } ] // Send payload with array of strings or objects: msg.payload = [ {title: "Apple", description: "A red fruit", icon: "https://example.com/apple.png"}, "Banana" ]; return msg;

Debug

Known issues

gotchaThe node requires at least Node-RED Dashboard 2.15.0 as a peer dependency. Older Dashboard versions may cause the node to not appear or malfunction.

fix

Update node-red-dashboard to version >=2.15.0.

affects: <0.3.0

gotchaWhen using the 'menu' action type, the menu items must be provided as an array in a 'menu' property of each item; otherwise, no menu will appear.

fix

Ensure each item has a 'menu' array with objects containing labels, etc.

affects: all

deprecatedThe 'icon_name' property expects Font Awesome 4.7 icon names. Font Awesome 5+ naming may not work.

fix

Use 'icon' with a URL or 'icon_unicode' for custom text icons instead.

affects: all

gotchaWhen 'Allow HTML in displayed text' is enabled, be cautious of XSS injections. The node does not sanitize HTML.

fix

Sanitize user inputs before sending to the node, or disable HTML if not needed.

affects: all

gotchaThe output payload on click/checkbox/switch actions includes an 'isChecked' boolean property; on menu actions, the selected menu item is in a 'selected' property. Forgetting this may cause parsing errors.

fix

Check the output payload structure in your downstream nodes.

affects: all

deprecatedThe node is based on Node-RED Dashboard 2.x APIs. Dashboard 3.x may not be fully compatible; future updates may be needed.

fix

Monitor the Node-RED Dashboard migration guides and update the node if needed.

affects: >=0.3.0

deprecatedSimple array of strings payload is supported, but mixing strings and objects in the same array may cause unexpected behavior.

fix

Use either all strings or all objects consistently.

affects: all

Errors

Common errors & fixes

Error: Cannot find module 'node-red-dashboard'

Missing peer dependency node-red-dashboard

fix

Install node-red-dashboard: cd ~/.node-red && npm install node-red-dashboard

ui-list node not appearing in palette

Incorrect installation directory or missing peer dependency

fix

Install the package in Node-RED user directory (~/.node-red) and ensure node-red-dashboard >=2.15.0 is installed.

msg.payload is not an array

Input payload is not an array as expected by the node

fix

Ensure msg.payload is an array of strings or objects. Example: msg.payload = ["Item1", "Item2"]

Cannot read property 'title' of undefined

Item object is missing required properties or is malformed

fix

Ensure each object has at least a 'title' property. Provide 'description' if lineType is not 'single-line' or action is not 'menu'.

Upgrade

Version history

0.3.6latest on npm

Audit

Dependencies

node-red-dashboardrequiredPeer dependency; required for the node to appear in the Node-RED Dashboard UI and provide the dashboard context.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/node-red/node-red-ui-nodes ↗

packagenode-red-node-ui-list ↗

homepagehttps://github.com/node-red/node-red-ui-nodes/blob/master/node-red-node-ui-list/README.md ↗