Skip to content

Add selector pattern documentation #92

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 25, 2025
Merged

Add selector pattern documentation #92

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
15 changes: 15 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 @@ -226,6 +226,21 @@ customNets.CUSTOMNET2 // "net.CUSTOMNET2"
// customNets.DOES_NOT_EXIST // TypeScript error!
```

### Collecting Typed Nets

You may want to group your typed nets alongside other reusable selectors:

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

const selectors = {
net: sel.net<"GND" | "VCC" | "V5">(),
// ...other selectors
}

selectors.net.GND // "net.GND"
```

### Dynamic Reference Designators

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