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

KToolTip: Add examples to the docs #628

Open
nucleogenesis opened this issue Apr 30, 2024 · 2 comments
Open

KToolTip: Add examples to the docs #628

nucleogenesis opened this issue Apr 30, 2024 · 2 comments

Comments

@nucleogenesis
Copy link
Member

nucleogenesis commented Apr 30, 2024

Overview

Continuing from @GarvitSinghal47 's work in #596 - KToolTip is another component that would be great to have examples for.

Guidance

Props

I think that providing an example demonstrating each prop would be suitable.

How to go about that is a bit open-ended, but a typical use of tooltips in Kolibri is when hovering a KIconButton to provide additional context.

So - one idea is to create a row of KIconButtons for things like "Edit", "Delete" , "Fullscreen".

Slot

I am not sure how best to demonstrate the default slot, however. I think that, typically, we don't want to use tooltips for anything except for providing context with text so I don't think we need to demonstrate using this.

Ideas?

I invite all additional suggestions in the comments.

@GarvitSinghal47
Copy link
Contributor

@nucleogenesis feel free to assign me the issue

@AlexVelezLl
Copy link
Member

To give examples of the slot, I think we can say that we can use this if we want more flexibility on the content styles of the tooltip. For example if we want to emphasize something, apply a <em> or <strong> tags, or if we want to add a header <h*> tag to the tooltip, etc.

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