FlowFuse/node-red-dashboard

template node should include practical code example related to node-red

Open

#1,558 opened on Dec 24, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)HTML (83 forks)auto 404
good first issuesize:Mstory

Repository metrics

Stars
 (350 stars)
PR merge metrics
 (PR metrics pending)

Description

Epic

No response

Description

As a: user

I want to: be able to a use template node and immediately see a practical code example that reflects a use-case in the context of node-red and not vue per se.

So that: Users can see how a template node can be used in the context of a node-red msg.payload with an object or array.

reasoning: Current default example does not help users in understanding the vue concept in context of node-red. A task list example with 2-way data binding could be more useful than a counter example that does not interact with node-red.

Which customers would this be availble to

All Users, (CE)

Acceptance Criteria

  • users can see the use of msg.payload within a template node
  • users can derive the use case of msg.payload in a loop, ie. v-for
  • users can see the use case of binding a payload property to an element, ie. v-text

Have you provided an initial effort estimate for this issue?

I can not provide an initial effort estimate

Contributor guide

Research direction
Review the current template node example in the codebase, and update it to use a practical example with msg.payload, v for, and v text based on the acceptance criteria.
Tech stack
nodejsvuejavascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node REDVue.jsGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75