-
Notifications
You must be signed in to change notification settings - Fork 50
Add CopperText docs page describing custom copper text element with examples and properties #472
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
Open
rushabhcodes
wants to merge
2
commits into
tscircuit:main
Choose a base branch
from
rushabhcodes:add-coppertext
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| title: <coppertext /> | ||
| description: >- | ||
| The `<coppertext />` element is used to add text directly to the copper layer | ||
| of a PCB. | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| The `<coppertext />` element is used to add text directly to the copper layer of a PCB. This is commonly used for reference designators, polarity indicators, or other markings that need to be part of the copper rather than silkscreen. | ||
|
|
||
| import CircuitPreview from "@site/src/components/CircuitPreview" | ||
|
|
||
| <CircuitPreview | ||
| hideSchematicTab | ||
| defaultView="pcb" | ||
| code={` | ||
| export default () => ( | ||
| <board width="10mm" height="10mm"> | ||
| <footprint> | ||
| <coppertext text="U1" pcbX="0" pcbY="0" fontSize="1mm" /> | ||
| </footprint> | ||
| </board> | ||
| ) | ||
| `} | ||
| /> | ||
|
|
||
| ## Properties | ||
|
|
||
| | Property | Type | Description | | ||
| | --- | --- | --- | | ||
| | `text` | string | The text string to display. | | ||
| | `pcbX` | length | X coordinate of the text position on the PCB. | | ||
| | `pcbY` | length | Y coordinate of the text position on the PCB | | ||
| | `anchorAlignment` | enum | Alignment of the text. One of "center", "top_left", "top_right", "bottom_left", "bottom_right". Defaults to "center". | | ||
| | `font` | enum | Optional. The font type, e.g. `"tscircuit2024"`. | | ||
| | `fontSize` | length | Optional. The size of the font. | | ||
| | `layers` | array | Optional. The copper layers to render on. Defaults to `["top"]`. | | ||
| | `knockout` | boolean | Optional. When true, removes copper under the text (creates a clear area). | | ||
| | `mirrored` | boolean | Optional. When true, mirrors the text. | | ||
| | `rotation` | number | Optional. Rotation angle in degrees. | | ||
|
|
||
| ## Knockout | ||
|
|
||
| The `knockout` prop removes the copper under the text, creating a clear area. This is useful for text like "GND" or "VCC" where you want to ensure the text is readable and not affected by copper pour. | ||
|
|
||
| <CircuitPreview | ||
| hideSchematicTab | ||
| defaultView="pcb" | ||
| code={` | ||
| export default () => ( | ||
| <board width="12mm" height="10mm"> | ||
| <footprint> | ||
| <coppertext text="GND" pcbX="-2.5" pcbY="0" fontSize="1.5mm" knockout /> | ||
| <coppertext text="VCC" pcbX="2.5" pcbY="0" fontSize="1.5mm" /> | ||
| </footprint> | ||
| </board> | ||
| ) | ||
| `} | ||
| /> | ||
|
|
||
| The left text has `knockout={true}` (copper removed underneath), while the right text does not. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.