Skip to content

Conversation

@knileshh
Copy link

Description

Documents the <hole /> component with pill shape and rotation support as requested in tscircuit/core#959.

Changes

  • Added comprehensive documentation for pill-shaped (oval) holes
  • Documented that pill shape props are defined but not yet implemented
  • Clarified that rotation is not supported for <hole /> (only for <platedhole />)
  • Added usage examples for circular holes, mounting holes, and footprints
  • Documented Circuit JSON output format for both circular and pill shapes
  • Added implementation notes for future pill shape support
  • Clarified the difference between <hole /> and <platedhole /> components

Related Issue

Fixes scircuit/core#959

- Add comprehensive documentation for pill-shaped (oval) holes
- Document that pill shape props exist but are not yet implemented
- Clarify rotation is not supported for <hole /> (only <platedhole />)
- Add usage examples for circular holes, mounting holes, and footprints
- Document Circuit JSON output format for both circular and pill shapes
- Add implementation notes for future pill shape support
- Clarify difference between <hole /> and <platedhole /> components

Addresses issue: tscircuit #959
@vercel
Copy link

vercel bot commented Oct 12, 2025

@knileshh is attempting to deploy a commit to the tscircuit Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@MustafaMulla29 MustafaMulla29 left a comment

Choose a reason for hiding this comment

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

I suggest you to look for other issues, as hole with pill shape is not yet supported. Am working on supporting it, here's the pr if you want to see tscircuit/circuit-to-svg#376

@knileshh
Copy link
Author

Yes, @MustafaMulla29 I noticed that, I just thought maybe no description was provided. I should try to make a PR with updating the docs with whatever is available.

@github-actions
Copy link

This PR has been automatically marked as stale because it has had no recent activity. It will be closed if no further activity occurs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document <hole /> with pill shape and rotation

2 participants