Skip to content

Update pcbnotedimension docs for auto measurements #283

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Oct 23, 2025
Merged

Update pcbnotedimension docs for auto measurements #283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/elements/pcbnotedimension.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import CircuitPreview from "@site/src/components/CircuitPreview"

## Overview

`<pcbnotedimension />` lets you add dimensional annotations to your PCB design. These annotations display the distance between two points with arrows and text labels, making it easy to communicate critical measurements for manufacturing, assembly, or design review. Dimension annotations are visible in PCB previews and can be exported with fabrication outputs.
`<pcbnotedimension />` lets you add dimensional annotations to your PCB design. These annotations display the distance between two points with arrows and an automatically generated measurement label, making it easy to communicate critical measurements for manufacturing, assembly, or design review. Dimension annotations are visible in PCB previews and can be exported with fabrication outputs.

## Basic Usage

Expand All @@ -25,7 +25,6 @@ Below is a simple board with a dimension annotation showing the distance between
<pcbnotedimension
from={{ x: -3, y: 2 }}
to={{ x: 3, y: 2 }}
text="6mm"
arrowSize={0.8}
fontSize={1.5}
color="#ffffff"
Expand All @@ -51,7 +50,6 @@ Instead of specifying exact coordinates, you can use selectors to reference comp
<pcbnotedimension
from="R1"
to="R2"
text="10mm spacing"
fontSize={1.2}
color="#00ff00"
/>
Expand All @@ -66,7 +64,7 @@ Instead of specifying exact coordinates, you can use selectors to reference comp
|---------|------|-------------|
| `from` | string \| Point | **Required.** Starting point of the dimension. Can be a selector string (e.g., `"R1"`) or a Point object with `x` and `y` coordinates. |
| `to` | string \| Point | **Required.** Ending point of the dimension. Can be a selector string (e.g., `"R2"`) or a Point object with `x` and `y` coordinates. |
| `text` | string | Label text to display on the dimension line (e.g., `"5mm"`, `"Critical spacing"`). |
| `text` | string | Optional custom label text to override the auto-generated measurement (e.g., `"Critical spacing"`). |
| `arrowSize` | length | Size of the arrows at each end of the dimension line. Defaults to `1mm`. |
| `fontSize` | length | Height of the label text. Defaults to `1mm`. |
| `color` | string | Hex color code for the dimension line, arrows, and text (e.g., `"#ffffff"`, `"#00ff00"`). |
Expand Down