lowcoder icon indicating copy to clipboard operation
lowcoder copied to clipboard

[Feat]: Optional description field for all components / elements

Open placidic opened this issue 1 year ago • 0 comments
trafficstars

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

As some applications can have a vast number of scripts and components, it would help to have a field to document the purpose or reasoning behind that particular implementation of that query or component.

It also can be beneficial when you have multiple developers working on a single application, or applications are handed off to new owners.

Further, this could be used to enhance the ability of self documenting lowcoder applications

Describe the solution you'd like A clear and concise description of what you want to happen.

For any component on the canvas, temporary state, transformer, query, I would like to have an optional field labeled description that I can populate with a markdown compatible explanation of the purpose of the component.

Ideally I would see it as a optional field in the advanced tab or properties of the component.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

placidic avatar Aug 13 '24 01:08 placidic