Added Overview And usage for ktooltip.vue component #789
Conversation
|
@MisRob please review this Pull request |
|
Thanks @sruthin21 |
There was a problem hiding this comment.
I'm sorry it took me such a long time to review @sruthin21. This is a solid basis, thank you! Here's a few issue I've noticed I'd like to ask you to address:
Also posting a few code comments regarding wording.
And lastly, would you fix linting issues?
docs/pages/ktooltip.vue
Outdated
|
|
||
| <DocsPageTemplate apiDocs /> | ||
| <DocsPageSection title="Overview" anchor="#overview"> | ||
| The KTooltip component is a Vue component used to display tooltips or hints when a user hovers over a specific element. |
There was a problem hiding this comment.
| The KTooltip component is a Vue component used to display tooltips or hints when a user hovers over a specific element. | |
| The KTooltip component displays a tooltip when a user hovers over a specific element. |
docs/pages/ktooltip.vue
Outdated
| </DocsPageSection> | ||
|
|
||
| <DocsPageSection title="Usage" anchor="#usage"> | ||
| <h4>Use Of Ref And Reference</h4> |
There was a problem hiding this comment.
| <h4>Use Of Ref And Reference</h4> | |
| <h4>Use of <code>ref</code> and <code>reference</code></h4> |
We don't capitalize titles, more here https://design-system.learningequality.org/writing/#punctuation
Would you update other section titles too?
docs/pages/ktooltip.vue
Outdated
| </KTooltip> | ||
| <button ref="myButton">Learn More</button> | ||
| </DocsShowCode> | ||
| <p>In this example, the `ref` attribute is used to create a reference to the `myButton` element, and the `reference` prop is used to associate the tooltip with this reference.</p> |
There was a problem hiding this comment.
Instead of using the ` character, such as in `ref`, would you use <code> in all places on this page? This will ensure it is rendered as code in the generated documentation.
|
Hi @sruthin21, are you planning to come back to this at some point? |
|
Hi @MisRob , Yes, I absolutely plan to come back to this! I apologize for the delay—I was tied up with my semester exams at college, which limited my availability to contribute. Thank you so much for your patience. I'll work on resolving this issue within the next 2-3 days. |
|
No problem at all @sruthin21, we just need to check-in from time to time, so we don't accidentally close something people want to return to. There's absolutely no pressure around this task, so feel free to come back whenever you can. Hoping your exams went well and get some rest :)! |
|
Thank you so much for understanding! 😊 I really appreciate the flexibility and support. My exams went well I’ll check back on this task soon. Thanks again for the patience and encouragement! 🙌 |
|
Hi @sruthin21, are you still planning some updates or would you like me to re-review? Also note that the link check is failing. |
|
Hi @sruthin21, by deleting your fork, unfortunately we won't be able to finish this PR. I will unassign you from #694, but feel free to message us and re-open if you'd like. |
FIXED ISSUE - #694
I Added Overview Section to KTooltip documentation page
with a brief introduction on what the component is for.
I Added Usage Section with sub-sections:-
1.The basic usage with an example code snippet that includes reference and refs
2. A visualization of the disabled state
3. A visualization of all supported placements
4. A visualization of maxWidth
[
Screen.Recording.2024-09-13.024929.mp4