Skip to content
This repository was archived by the owner on Jul 7, 2025. It is now read-only.

Add documentation for the ConfirmationDialog component#943

Closed
francisfuzz wants to merge 8 commits intomainfrom
francisfuzz/primer-5198
Closed

Add documentation for the ConfirmationDialog component#943
francisfuzz wants to merge 8 commits intomainfrom
francisfuzz/primer-5198

Conversation

@francisfuzz
Copy link
Contributor

@francisfuzz francisfuzz commented Jul 2, 2025

Summary

Closes https://github.com/github/primer/issues/5198

This PR adds documentation for the ConfirmationDialog component. It follows the same convention as its sibling components with the metadata and imports at the top. I used Copilot Agent mode to contextualize the example based on what's in primer/react's source code, and validated it on my own read.

I believe this is at the 30% mark and don't expect it to be approved as-is.

For reviewers, here's the deploy preview: https://primer-34f3f200fc-26441320.drafts.github.io/components/confirmation-dialog

And, my questions:

  • Structure: are there any other items that would make this compatible with the "new" version of Primer Style?
  • Content: is what's presented here enough and are there any other items that would make this "feature complete"?
  • Clarification: should anything be codified separately from the examples, like gesture control options?

Thank you! 🙇🏽

<img
width="960"
alt="Anatomy of a ConfirmationDialog showing header, body content, and action buttons"
src="https://github.com/user-attachments/assets/fb545bc1-0b21-43dd-bfb4-378ffef894a8"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 This isn't final. We'll need a "real" Anatomy here in place of this one, so it's here as a placeholder.

Comment on lines +6 to +7
reactId: confirmation-dialog
figmaId: confirmation-dialog
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❓ Question for reviewers: how do I validate these IDs are pointing to the correct reference outbound to the React source code or Figma URL?

@francisfuzz francisfuzz marked this pull request as ready for review July 2, 2025 18:51
@francisfuzz francisfuzz requested a review from a team as a code owner July 2, 2025 18:51
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@francisfuzz
Copy link
Contributor Author

Closing, will re-work this ✌🏽

@francisfuzz francisfuzz closed this Jul 2, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant