Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show Element Documentation and Properties on mouse click/hover #9

Open
n0vi opened this issue Apr 2, 2020 · 4 comments
Open

Show Element Documentation and Properties on mouse click/hover #9

n0vi opened this issue Apr 2, 2020 · 4 comments

Comments

@n0vi
Copy link

n0vi commented Apr 2, 2020

Currently Element properties are not exported.

Being able to see them as a table or list after a click on the element on a diagram would make the export more useful and complete.

My workflow relies on using element properties a lot to describe common things like implementation language, api endpoint address, urls to logging, source code repository, etc. Actually, a diagram picture and the stuff around in the element properties is the most valuable piece for that kind of workflow when exploring documentation.

@jbsarrodie
Copy link
Member

That's something I'm thinking about. My main issue is related to user experience because that's easy to add another main tab (between Documentation and Elements) for view's properties, but that's harder to integrate for elements' and relationships' properties.

One option (easy to implement) I though about is to add properties as a collapsible section behing each documentation (for view but also elements and relationships). This section would exist only if there is at least one property and would be collapsed by default.

Ideas and suggestions are welcome.

@n0vi
Copy link
Author

n0vi commented Apr 3, 2020

I see, how about css onhover tooltip that shows properties?
Something similar to codepen css tooltip sample.

@jbsarrodie
Copy link
Member

how about css onhover tooltip that shows properties?

I though about it too. I don't think it would be useful for view's properties (a tab or a section would be better IMHO) but that could make it for elements and relationships.

@n0vi n0vi changed the title Show Element Documentation and Properties on click Show Element Documentation and Properties on mouse click/hover Apr 4, 2020
@evlibra
Copy link

evlibra commented Nov 30, 2020

Implementing this (or at least description) would really make the html export usable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants