vaadin / designer

Public repository for Vaadin Designer
https://vaadin.com/designer
16 stars 3 forks source link

Component description panel for palette #2312

Open stefanuebe opened 4 years ago

stefanuebe commented 4 years ago

Actual behavior / Description

We have a lot of components. I mean really a lot. Due to the nature of our (or in general all) web components there are many components, that are not self explaining and where the meaning has to be slurped out from some deep tech docs from some component pages. Best example for that are the grid sub components:

Even I as a Vaadineer couldn't explain all of them: image

But not only the amount of elements can be irritating, also the fact, that you can combine everything with everything (for instance put a grid inside a button label, put a context menu item inside a form layout, ...) and no one tells you, that you're wrong.

Expected behavior

The request is, that we should provide a documentation panel somewhere that explains:

This panel could take a part of the palette or optionally float when hovering an element. The documentation panels from IntelliJ or Eclipse are a good examples of how it could look like and behave (especially the very well working floating version).

For the documentation and examples: We should be aware, that the designer is also used by users, that are not heavy trained UX desingers, but simple people like me, who do not know Polymer very well (and maybe won't to - otherwise they wouldn't use a wysiwyg designer, but simply write the source code by hand).

IDE, Designer and OS version

IntelliJ, Designer 4.5.0, Chrome Editor Windows 10

stale[bot] commented 3 years ago

Hello there!

It looks like this issue hasn't progressed lately. There are so many issues that we just can't deal them all within a reasonable timeframe.

There are a few things you could help to get things rolling on this issue (this is an automated message, so expect that some of these are already in use):

Thanks again for your contributions! Even though we haven't been able to get this issue fixed, we hope you to report your findings and enhancement ideas in the future too!