Skip to content

Document schDisplayLabel for trace #758

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
MustafaMulla29 merged 2 commits into from
Jun 23, 2026
Merged

Document schDisplayLabel for trace #758

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef103e1
Document schDisplayLabel for trace
MustafaMulla29 Jun 23, 2026
8d3cbc7
upd
MustafaMulla29 Jun 23, 2026
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
26 changes: 25 additions & 1 deletion docs/elements/trace.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: <trace />
sidebar_position: 5
description: >-
The `<trace />` element represents an electrical connection between two or
more points in your circuit. Traces can connect components, nets, or specific
Expand Down Expand Up @@ -36,6 +35,7 @@ Here's a simple example connecting two components:
| -------- | ----------- | ------- |
| `from` | Starting point of the trace using a [port selector](../guides/tscircuit-essentials/port-and-net-selectors.md) | `".R1 > .pin1"` |
| `to` | Ending point of the trace using a [port selector](../guides/tscircuit-essentials/port-and-net-selectors.md) | `".C1 > .pin1"` |
| `schDisplayLabel` | Schematic label text to render for the trace instead of an autogenerated fallback net label (optional) | `"SENSE"` |
| `maxLength` | Maximum length the trace can be (optional) | `"10mm"` |
| `minLength` | Minimum length the trace must be (optional) | `"5mm"` |
| `width` | Width of the trace (optional) | `"0.2mm"` |
Expand All @@ -57,6 +57,30 @@ Traces can connect to named nets like power and ground:
)
`} />

## Custom Schematic Labels

Use `schDisplayLabel` when you want a trace to show a specific net label in the schematic. This is useful for direct port-to-port traces, where the renderer would otherwise fall back to an autogenerated label based on the connected ports.

<CircuitPreview defaultView="schematic" hidePCBTab hide3DTab code={`
export default () => (
<board width="10mm" height="10mm">
<resistor name="R1" resistance="10k" footprint="0402" schX={-2} />
<chip name="U1" footprint="soic8" schX={2} />
<trace
from=".R1 > .pin1"
to=".U1 > .pin1"
schDisplayLabel="SENSE"
/>
<trace
from=".R1 > .pin2"
to="net.GND"
/>
</board>
)
`} />

`schDisplayLabel` controls the schematic label that is drawn for the trace; it does not rename the underlying net.

## Autorouting

Traces are automatically routed by tscircuit's [autorouting system](./board.mdx#setting-the-autorouter). The autorouter will:
Expand Down
Loading