devtools icon indicating copy to clipboard operation
devtools copied to clipboard
verified publisher icon flutter

Property editor: Show description of each property

Open mit-mit opened this issue 8 months ago • 2 comments

One of the main use cases I'm thinking of for the Property Editor is to help new developers discover what some of the main properties are, and what they do. To make such discovery easier I propose we show a bit of domentation text next to each property.

Sample visualization (see small text below the properties):

Image

mit-mit avatar May 06 '25 12:05 mit-mit

HI @mit-mit! Currently the documentation (if its available, not every parameter has a dartdoc comment) is included in the tooltip when you hover of the info icon (i). What do you think? We were trying to balance discoverability with saving screen real estate, though seems like it might need to be more discoverable 😅

elliette avatar May 30 '25 23:05 elliette

I think that for new users permanently showing it would be a big help. Perhaps for more experienced users hiding it (e.g. via a preference) might be useful, but not sure how much experienced devs would use this tool?

Just my instinct. Maybe @anderdobo has thoughts too?

mit-mit avatar Jun 02 '25 08:06 mit-mit