{"id":41622,"library":"node-red-node-ui-list","title":"Node-RED Dashboard UI List Node","description":"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.","status":"active","version":"0.3.6","language":"javascript","source_language":"en","source_url":"https://github.com/node-red/node-red-ui-nodes","tags":["javascript","node-red","node-red-dashboard","dashboard","list"],"install":[{"cmd":"npm install node-red-node-ui-list","lang":"bash","label":"npm"},{"cmd":"yarn add node-red-node-ui-list","lang":"bash","label":"yarn"},{"cmd":"pnpm add node-red-node-ui-list","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency; required for the node to appear in the Node-RED Dashboard UI and provide the dashboard context.","package":"node-red-dashboard","optional":false}],"imports":[{"note":"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.","wrong":"npm install node-red-node-ui-list --save-dev","symbol":"ui_list","correct":"npm install node-red-node-ui-list"}],"quickstart":{"code":"// This node is used via Node-RED flow editor, not via code.\n// To use it, install the package and add the ui-list node from the palette.\n// Example flow JSON:\n[\n    {\n        \"id\": \"93612884.34d35\",\n        \"type\": \"ui_list\",\n        \"z\": \"ee47c5e8.e17bd\",\n        \"group\": \"7e4c65d6.0419cc\",\n        \"name\": \"\",\n        \"order\": 1,\n        \"width\": \"6\",\n        \"height\": \"5\",\n        \"lineType\": \"three\",\n        \"actionType\": \"click\",\n        \"allowHTML\": true,\n        \"x\": 290,\n        \"y\": 100,\n        \"wires\": [[\"cd592928.56da38\"]]\n    }\n]\n// Send payload with array of strings or objects:\nmsg.payload = [\n    {title: \"Apple\", description: \"A red fruit\", icon: \"https://example.com/apple.png\"},\n    \"Banana\"\n];\nreturn msg;","lang":"javascript","description":"Shows installation command and a minimal flow snippet demonstrating the ui_list node configuration and expected input payload."},"warnings":[{"fix":"Update node-red-dashboard to version >=2.15.0.","message":"The 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.","severity":"gotcha","affected_versions":"<0.3.0"},{"fix":"Ensure each item has a 'menu' array with objects containing labels, etc.","message":"When 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.","severity":"gotcha","affected_versions":"all"},{"fix":"Use 'icon' with a URL or 'icon_unicode' for custom text icons instead.","message":"The 'icon_name' property expects Font Awesome 4.7 icon names. Font Awesome 5+ naming may not work.","severity":"deprecated","affected_versions":"all"},{"fix":"Sanitize user inputs before sending to the node, or disable HTML if not needed.","message":"When 'Allow HTML in displayed text' is enabled, be cautious of XSS injections. The node does not sanitize HTML.","severity":"gotcha","affected_versions":"all"},{"fix":"Check the output payload structure in your downstream nodes.","message":"The 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.","severity":"gotcha","affected_versions":"all"},{"fix":"Monitor the Node-RED Dashboard migration guides and update the node if needed.","message":"The node is based on Node-RED Dashboard 2.x APIs. Dashboard 3.x may not be fully compatible; future updates may be needed.","severity":"deprecated","affected_versions":">=0.3.0"},{"fix":"Use either all strings or all objects consistently.","message":"Simple array of strings payload is supported, but mixing strings and objects in the same array may cause unexpected behavior.","severity":"deprecated","affected_versions":"all"}],"env_vars":null,"search_vec":"'0.19':58 '0.3.6':45 '2.0':80 '2.15':53 'array':88 'awesom':29 'cadenc':97 'checkbox':38 'click':37 'complex':90 'current':41 'custom':60 'dashboard':4,12,52,61,79,111,112 'descript':25 'display':16 'font':28 'framework':82 'html':94 'icon':26 'integr':75 'interact':34 'item':20 'javascript':104 'list':6,18,113 'maintain':67 'menu':40 'minor':101 'mode':35 'multipl':33 'node':2,7,10,14,50,56,64,71,106,109 'node-r':1,9,49,55,70,105 'node-red-dashboard':108 'none':36 'object':91 'offici':66 'option':93 'pair':47 'patch':102 'red':3,11,51,57,72,107,110 'releas':96 'render':95 'seamless':76 'simpl':86 'sporad':99 'stabl':42 'string':87 'support':22,84 'switch':39 'team':73 'titl':24 'ui':5,81 'unicod':31 'unlik':59 'updat':103 'url':27 'version':43 'widget':13,62","created_at":"2026-06-04T18:53:18.551072+00:00","updated_at":"2026-06-04T18:53:18.551072+00:00","problems":[{"fix":"Install node-red-dashboard: cd ~/.node-red && npm install node-red-dashboard","cause":"Missing peer dependency node-red-dashboard","error":"Error: Cannot find module 'node-red-dashboard'"},{"fix":"Install the package in Node-RED user directory (~/.node-red) and ensure node-red-dashboard >=2.15.0 is installed.","cause":"Incorrect installation directory or missing peer dependency","error":"ui-list node not appearing in palette"},{"fix":"Ensure msg.payload is an array of strings or objects. Example: msg.payload = [\"Item1\", \"Item2\"]","cause":"Input payload is not an array as expected by the node","error":"msg.payload is not an array"},{"fix":"Ensure each object has at least a 'title' property. Provide 'description' if lineType is not 'single-line' or action is not 'menu'.","cause":"Item object is missing required properties or is malformed","error":"Cannot read property 'title' of undefined"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/node-red/node-red-ui-nodes/blob/master/node-red-node-ui-list/README.md","github":"https://github.com/node-red/node-red-ui-nodes","docs":null,"changelog":null,"pypi":null,"npm":"node-red-node-ui-list","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}