-
Notifications
You must be signed in to change notification settings - Fork 3
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
Addons: form for tooltips #521
Conversation
Required by readthedocs/addons#379
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The technical changes here look fine, but I raised a point about the naming here. I would not call this element a "tooltip", this is a specific term for this element:
Tooltips are a text only element, usually used to describe a field/button/element, and these are normally not rich content elements. I'd call what we inject a popover or popup.
Noted in chat, but this is a clear review of the terms here:
https://medium.com/design-bootcamp/popups-dialogs-tooltips-and-popovers-ux-patterns-2-939da7a1ddcd
I renamed "Tooltips" by "Link Previews" |
We decided to not merge this PR yet so we can start testing it ourselves with our own projects first. |
This PR needs to be adapted now that we have |
…m:readthedocs/ext-theme into humitos/addons-tooltips-form
I think you missed my question from here, @agjohnson |
Sounds like there's a |
There is a wrapping class that the menu can use: https://fomantic-ui.com/collections/menu.html#wrapping However, that also looks pretty similar to what we have. The centered wrapping looks a little better though: https://fomantic-ui.com/collections/menu.html#centered-fluid-wrapping |
Do we have docs for this? I'm assuming this is "shipping" this feature? |
Good point. We don't have specific documentation for this yet. We only have the description of the backend API and a link to hoverxref in https://docs.readthedocs.io/en/stable/guides/embedding-content.html I will try to quickly update that page to remove the recommendation for hoverxref and link to a new addons page for links preview with small content for now. |
Required by readthedocs/addons#379
Required by readthedocs/readthedocs.org#11746
Closes readthedocs/addons#239