Skip to content

Update docs for custom net selectors #90

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
Jun 23, 2025
Merged

Update docs for custom net selectors #90

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
17 changes: 17 additions & 0 deletions docs/guides/using-sel-references.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,23 @@ selU2.custompin2 // Returns ".U2 > .custompin2"
// selU2.doesnotexist // TypeScript error!
```

### Generic Net Selectors

You can also create custom net selectors using TypeScript generics:

```tsx
import { sel } from "tscircuit"

// Define custom net names using generics
const customNets = sel.net<"CUSTOMNET1" | "CUSTOMNET2">()

customNets.CUSTOMNET1 // "net.CUSTOMNET1"
customNets.CUSTOMNET2 // "net.CUSTOMNET2"

// TypeScript will error on non-existent nets!
// customNets.DOES_NOT_EXIST // TypeScript error!
```

### Dynamic Reference Designators

You can call `sel` as a function to create selectors for any reference designator.
Expand Down