Skip to content

Commit

Permalink
Reorg Repo to match node names
Browse files Browse the repository at this point in the history
update all docs, examples, README, links to be consistent across projects
  • Loading branch information
Dave Conway-Jones committed Aug 23, 2019
1 parent 2a6bb0a commit cabe09c
Show file tree
Hide file tree
Showing 41 changed files with 28 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Additional nodes for Node-RED Dashboard
This repository contains a few example extra Dashboard Widgets for the [Node-RED
Dashboard](https://flows.nodered.org/node/node-red-dashboard) project - along with documentation that should be enough to help you create your own. In order to work they require both [Node-RED](https://nodered.org) and Node-RED-Dashboard to be installed.

Most widgets will be published as their own standalone npm packages called node-red-node-ui-*something*, rather than as part of this repo.
Most widgets will be published as their own standalone npm packages called node-red-node-ui-*something*, rather than as part of this repo. If you create your own nodes please try to call them node-red-contrib-ui-*something*.

A basic knowledge of Javascript is required, and the UI itself uses Angular version 1 and jQuery, so a knowledge of, or a willingness to learn, some of these would be an advantage.

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
node-red-ui-node-lineargauge
node-red-node-ui-lineargauge
============================

A Node-Red ui node that creates a linear gauge with high/low limits and animated sliding pointer.
Expand All @@ -15,7 +15,7 @@ Low Limit: `msg.lowlimit`

Using `msg.payload` as the value to display and position the pointer.

![LinearGaugeImg](https://github.com/node-red/node-red-ui-nodes/node-red-ui-node-lineargauge/imgs/linearGauges.PNG?raw=true)
![LinearGaugeImg](https://github.com/node-red/node-red-ui-nodes/node-red-node-ui-lineargauge/imgs/linearGauges.PNG?raw=true)

## Requirements
Node-Red v19.4 or greater
Expand All @@ -24,7 +24,7 @@ Node-Red-dashboard v2.13.0 or greater
## Install
Either use the Editor - Menu - Manage Palette - Install option, or run the following command in your Node-RED user directory (typically `~/.node-red`) after installing Node-RED-dashboard.

npm i node-red-ui-node-lineargauge
npm i node-red-node-ui-lineargauge


# Example
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-red-node-ui-lineargauge",
"version": "0.3.3",
"version": "0.3.4",
"description": "A Node Red ui node to display a linear gauge on the dashboard.",
"dependencies": {},
"author": "Seth Johnson (https://github.com/seth350)",
Expand All @@ -10,15 +10,14 @@
"license": "Apache-2.0",
"keywords": [
"node-red",
"gauge",
"node-red-dashboard",
"ui",
"gauge",
"linear"
],
"bugs": {
"url": "https://github.com/node-red/node-red-ui-nodes/issues"
},
"homepage": "https://github.com/node-red/node-red-ui-nodes/node-red-ui-node-lineargauge",
"homepage": "https://github.com/node-red/node-red-ui-nodes/node-red-node-ui-lineargauge#README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/node-red/node-red-ui-nodes.git"
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
node-red-node-ui_list
node-red-node-ui-list
=====================

A Node-RED widget node for showing a list of items.
Expand All @@ -11,14 +11,14 @@ Install
Either use the Menu - Manage Palette option to install the node, or run the following command
in your Node-RED user directory - typically `~/.node-red`

npm i node-red-node-ui_list
npm i node-red-node-ui-list

**Note**: This node uses APIs that require at least Node-RED 0.19 and Node-RED Dashboard 2.10.

Usage
-----

`ui_list` node is a UI widget that can be used to display a list of items in the Node-RED dashboard.
`ui-list` node is a UI widget that can be used to display a list of items in the Node-RED dashboard.

An array of Items is passed in by `msg.payload`. It consists of objects containing the following properties.

Expand Down Expand Up @@ -52,7 +52,7 @@ Example
{
"id": "ee47c5e8.e17bd",
"type": "tab",
"label": "Example of ui_list",
"label": "Example of ui-list",
"disabled": false,
"info": ""
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
"id": "ee47c5e8.e17bd",
"type": "tab",
"label": "Example of ui_list",
"label": "Example of ui-list",
"disabled": false,
"info": ""
},
Expand Down
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-red-node-ui-list",
"version": "0.2.0",
"version": "0.2.1",
"description": "Node-RED Dashboard UI widget node for simple list",
"author": "Hiroyasu Nishiyama",
"contributors": [
Expand All @@ -17,7 +17,10 @@
"type": "git",
"url": "https://github.com/node-red/node-red-ui-nodes.git"
},
"homepage": "https://github.com/node-red/node-red-ui-nodes/tree/master/node-red-ui-node-list#README.md",
"bugs": {
"url": "https://github.com/node-red/node-red-ui-nodes/issues"
},
"homepage": "https://github.com/node-red/node-red-ui-nodes/tree/master/node-red-node-ui-list#README.md",
"keywords": [
"node-red",
"node-red-dashboard",
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
node-red-ui-node-mylittleuinode
node-red-node-ui-mylittleuinode
===============================

A Node-Red dashboard ui node to help you create your own ui node.
Expand All @@ -12,7 +12,7 @@ developers to use to create their own UI widgets.

Either use the Editor - Menu - Manage Palette - Install option, or run the following command in your Node-RED user directory (typically `~/.node-red`) after installing Node-RED-dashboard.

npm i node-red-ui-node-mylittleuinode
npm i node-red-node-ui-mylittleuinode

## Inputs
Send `msg.payload` to this node to change the text displayed in the textbox.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-red-node-ui-mylittleuinode",
"version": "0.0.1",
"version": "0.0.2",
"description": "A Node-Red dashboard ui node to help you create your own ui node.",
"dependencies": {},
"author": "Seth Johnson (https://github.com/seth350)",
Expand All @@ -10,13 +10,12 @@
"license": "Apache-2.0",
"keywords": [
"dashboard",
"ui",
"example"
],
"bugs": {
"url":"https://github.com/node-red/node-red-ui-nodes/issues"
},
"homepage":"https://github.com/node-red/node-red-ui-nodes/node-red-ui-node-mylittleuinode",
"homepage":"https://github.com/node-red/node-red-ui-nodes/node-red-node-ui-mylittleuinode#README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/node-red/node-red-ui-nodes.git"
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
node-red-ui-node-table
node-red-node-ui-table
======================

A Node-RED UI widget node which displays data as a table.
Expand All @@ -7,7 +7,7 @@ A Node-RED UI widget node which displays data as a table.

Either use the Editor - Menu - Manage Palette - Install option, or run the following command in your Node-RED user directory (typically `~/.node-red`) after installing Node-RED-dashboard.

npm i node-red-ui-node-table
npm i node-red-node-ui-table

## Usage

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "node-red-node-ui-table",
"version": "0.1.1",
"version": "0.1.2",
"description": "Table UI widget node for Node-RED Dashboard",
"author": "Kazuhito Yokoi",
"contributors": ["Dave Conway-Jones","@hotNipi"],
Expand All @@ -14,7 +14,10 @@
"type": "git",
"url": "git+https://github.com/node-red/node-red-ui-nodes.git"
},
"homepage": "https://github.com/node-red/node-red-ui-nodes/tree/master/node-red-ui-node-table#README.md",
"bugs": {
"url":"https://github.com/node-red/node-red-ui-nodes/issues"
},
"homepage": "https://github.com/node-red/node-red-ui-nodes/tree/master/node-red-node-ui-table#README.md",
"keywords": [
"node-red",
"node-red-dashboard",
Expand Down
File renamed without changes
File renamed without changes

0 comments on commit cabe09c

Please sign in to comment.