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

Create components for building in-app documentation and help content #914

Closed
seancolsen opened this issue Dec 21, 2021 · 3 comments · Fixed by #1024
Closed

Create components for building in-app documentation and help content #914

seancolsen opened this issue Dec 21, 2021 · 3 comments · Fixed by #1024
Assignees
Labels
ready Ready for implementation type: enhancement New feature or request work: frontend Related to frontend code in the mathesar_ui directory

Comments

@seancolsen
Copy link
Contributor

We need a Tooltip or Help component, akin to Carbon's Tooltip component that will allow us to add documentation and help messages within the UI.

@seancolsen seancolsen added type: enhancement New feature or request work: frontend Related to frontend code in the mathesar_ui directory ready Ready for implementation labels Dec 21, 2021
@pavish
Copy link
Member

pavish commented Dec 21, 2021

I think it would be better to implement Tooltip as an action, so that we can attach one to any element.

We could have a help component that uses Icon and Tooltip to provide similar functionality as Carbon's tooltip component.

@seancolsen
Copy link
Contributor Author

Using actions under the hood seems great. We'll need to be mindful about supporting rich text within tooltip content, which might be a little trickier with actions, but still worth going that direction I think.

@pavish
Copy link
Member

pavish commented Dec 21, 2021

I don't think tooltips should support rich text. If we need support for rich text or custom components, it should rather be a popover component.

We already have the popper action which can convert any element into a dropdown or a popover, which can be used for such scenarios. We'd also probably want to implement tooltip on top of this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready Ready for implementation type: enhancement New feature or request work: frontend Related to frontend code in the mathesar_ui directory
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants