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

RichTooltip/Popover component - PopoverPrimitive component documentation [03b] #2046

Merged

Conversation

didoo
Copy link
Contributor

@didoo didoo commented Apr 10, 2024

📌 Summary

This PR is meant to be on top of #2045 so that it's easier to review the documentation for the PopoverPrimitive component in isolation.

🛠️ Detailed description

In this PR I have:

  • added “Component API” documentation for the PopoverPrimitive component
  • added “How to use” documentation for the PopoverPrimitive component
    • notice: given the complexity of the component, is not possible to cover all the possible ways to use it, so I've given a few basic examples and I defer to the code itself for details
  • added acceptance tests for the PopoverPrimitive component

👓 Preview

🔗 External links

Jira ticket: https://hashicorp.atlassian.net/browse/HDS-3211 (Main task)

RFC document: https://docs.google.com/document/d/1ey8LVQn0sA0bPbKoaz93ZoYVO1cLcbXUeg1o-tf6LIY/

Figma file: https://www.figma.com/file/noyY6dUMDYjmySpHcMjhkN/branch/ZiYg2uadc2fCNQ5tMzQqi8/HDS-Product---Components?type=design&node-id=55408-54938&mode=design&t=qDUIxW9WBWLLM1HG-0


👀 Component checklist

💬 Please consider using conventional comments when reviewing this PR.

Copy link

vercel bot commented Apr 10, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview May 1, 2024 5:28pm
hds-website ✅ Ready (Inspect) Visit Preview May 1, 2024 5:28pm

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Apr 10, 2024
@didoo didoo changed the title 03b popover primitive documentation RichTooltip/Popover component - PopoverPrimitive component documentation [03b] Apr 10, 2024
@didoo didoo changed the title RichTooltip/Popover component - PopoverPrimitive component documentation [03b] RichTooltip/Popover component - PopoverPrimitive component documentation [03b] Apr 10, 2024
@didoo
Copy link
Contributor Author

didoo commented Apr 10, 2024

@jorytindall we need an illustration for this primitive (is a generic primitive for the popover, not sure how to visualize it, maybe the showcase can help in give you some ideas?)

@didoo didoo force-pushed the 03-popover-primitive-implementation branch from 24da3b1 to 7c8ffce Compare April 10, 2024 11:52
@didoo didoo force-pushed the 03b-popover-primitive-documentation branch from b886e91 to 8886c73 Compare April 10, 2024 12:09
@didoo didoo force-pushed the 03-popover-primitive-implementation branch from 7c8ffce to 00e3272 Compare April 11, 2024 11:37
@didoo didoo force-pushed the 03b-popover-primitive-documentation branch from 8886c73 to 24727f6 Compare April 11, 2024 13:12
@didoo didoo force-pushed the 03b-popover-primitive-documentation branch from c6c4969 to 3bcc612 Compare April 15, 2024 13:35
@didoo didoo force-pushed the 03-popover-primitive-implementation branch from e7dcf36 to 6009172 Compare April 15, 2024 16:26
@didoo didoo force-pushed the 03b-popover-primitive-documentation branch from 3bcc612 to b688fcc Compare April 15, 2024 16:27
@didoo didoo force-pushed the 03-popover-primitive-implementation branch from 6009172 to f53eab0 Compare April 15, 2024 16:52
@didoo didoo force-pushed the 03b-popover-primitive-documentation branch from b688fcc to 562507f Compare April 15, 2024 16:53
@didoo didoo force-pushed the 03-popover-primitive-implementation branch from f53eab0 to a4d89d7 Compare April 15, 2024 17:37
@didoo didoo force-pushed the 03b-popover-primitive-documentation branch from 562507f to 7879636 Compare April 15, 2024 17:38
Co-authored-by: Kristin Bradley <kristin.bradley@hashicorp.com>
Co-authored-by: Melanie Sumner <melanie@hashicorp.com>
Base automatically changed from 03-popover-primitive-implementation to 00-popover-feature-branch May 8, 2024 17:41
@didoo
Copy link
Contributor Author

didoo commented May 8, 2024

@alex-ju @KristinLBradley @MelSumner let me know if you want to review this one, otherwise I can merge it without review for the PopoverPrimitive documentation

@didoo didoo merged commit 8418545 into 00-popover-feature-branch May 9, 2024
16 checks passed
@didoo didoo deleted the 03b-popover-primitive-documentation branch May 9, 2024 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants