Special indication on nodes with description

Core Development Feature Requests
63

I'm thinking about the status topic - the text property remains the current status under the node and a new property description allows to show more in the Sidebar.

There are already three and I don't see what you want to do with the new one? Highlighted the description?

64

Totally agree with this.

There are other (contributed) nodes that would potentially benefit from such a split and I'm hoping that when Node.js v20 (or might be 21, can't remember) becomes the baseline with full support for submodules, this will be more straightforward because you will be able to use a monorepo "properly". Well that's my understanding anyway.

But, we are off topic - again! :wink:

1 Like
65

In my defense, I would like to say that I posted this feature request out of a certain frustration, after spending at least an hour trying to reinvent the wheel, only to realize shortly thereafter that I had neatly documented everything in the (hidden) node's description some time ago.

Nobody likes overcluttered GUIs. So maybe, it is indeed a bad idea to implement this.

3 Likes
66

Hah - I'll drink to that :beers:

67

If only you had remembered to change the icon when you added the documentation! :stuck_out_tongue_closed_eyes:

Sadly all icons are invisible on the comment node. This is fa-envelope-open-o
image

68

I don't think it is a bad idea, but maybe not something that everyone wants on all the time.

Just trying to play with some ideas myself as, even if this isn't adopted in core, I think I'd like something I could implement myself (and share with others of course).

But at the moment, I'm slightly struggling to adapt @gregorius's code above:

His current code only updates after you open and close a node. Is there an event that I could use that will trigger when the page is loaded and after all the nodes are rendered?

Positioning not yet allowing for different node sizes but starting to get there:

image
image859Ɨ257 20.9 KB

Still a bit distracting though. Need to tone it down further.

Or this - which has the advantage that the indicator is within the icon box which means it would still be inside it if the icon is on the other side.

image

69

That's why I was looking for a sober icon to put inside the node

Try with RED.events.on("runtime-state") but not sure

70

Thanks, I'll try it.

This is even more subtle & I might try this for a while:

image

It just makes the separator thicker.

Drat - but no, doesn't work when the node is collapsed to just its icon as that border is dynamically hidden constantly.

Hmm, making the whole border 2 thick instead of 1?

image

71

I had thought of put an "i" in a corner? (the bottom right)

72

Personally, I think that some kind of icon, even an i would be distracting, especially if you have a lot of descriptions.

As others have commented I think, it is really very easy to ruin a visual UX with clutter.

But just my opinion.

More importantly though, getting to a consistent bottom-right is actually quite hard unless you amend core I think. Since nodes can change size. Though haven't tried that hard so I may be missing something obvious.

73

Capture dā€™eĢcran 2024-01-26 aĢ€ 22.11.16

74

OK, I could be persuaded.

Of course, none of this is accessible. But accessible visual programming is a very hard problem. And since the description can still be accessed other ways, there probably isn't an easy answer.

75

I understand Remo's frustration, what he is asking is to just know that a node has a description - like the "inject" node does when enabling the repeat.

1 Like
76

I can now definitely do something for myself which is good. The code is relatively easy once you know the trick.

Did you manage to find a robust way to get that i into the bottom-right corner?

77

Is this topic still referring to how to identify nodes with a description?
Haven't been nosey on this topic too much

1 Like
78

Use the following to calculate its position:

RED.view.node_width and RED.view.node_height

Yep :roll_eyes:

1 Like
79

Just to interferer with my own thoughts ..

(I am currently listening to Kate Bush - so ... you know...)

Screenshot 2024-01-26 at 21.22.42

80

This is precisely the kind of idea that Nick and Dave try to avoid because it pollutes the rendering of the node. It shouldn't be too visible and the idea of a new badge is disturbing (and too showy)

You are forgiven :joy: :wink:

81

I feel this topic is hard to get right.
anyway - to not draw to much attention - but still have a purpose

Screenshot 2024-01-26 at 21.32.29

82

I had this kind of idea, initially I wanted something that looked like the "file-text" icon but I couldn't get the right size (because svg). To see if the upper corner is better :man_shrugging: