Skip to content

Add inline prop to netlabel - #814

Merged
seveibar merged 1 commit into
mainfrom
feat/netlabel-inline-prop
Aug 24, 2026
Merged

Add inline prop to netlabel#814
seveibar merged 1 commit into
mainfrom
feat/netlabel-inline-prop

Conversation

@seveibar

Copy link
Copy Markdown
Contributor

Summary

  • add the optional boolean inline prop to NetLabelProps
  • parse inline through the canonical netlabel Zod schema
  • document that inline schematic placement is automatic and ignores anchored positioning props
  • regenerate the component type and props documentation

Behavior

inline is optional and has no schema default, so omitted or false preserves the existing anchored netlabel behavior. Core can use true to render the net name along its schematic trace.

Validation

  • bun scripts/generate-component-types.ts
  • bun scripts/generate-manual-edits-docs.ts
  • bun scripts/generate-readme-docs.ts
  • bun scripts/generate-props-overview.ts
  • bun run typecheck
  • bun run build
  • bunx biome format lib/components/netlabel.ts
  • git diff --check

@seveibar
seveibar merged commit c831c4f into main Aug 24, 2026
4 checks passed
Comment on lines +3234 to +3238
/**
* Render the net name along its schematic trace instead of as an anchored
* label. Inline placement is automatic, so schematic anchor positioning
* props are ignored.
*/

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSDoc comment is misplaced. The comment describes the inline property but is positioned between the interface closing brace (line 3233) and the netLabelProps zod schema declaration (line 3239). This will cause documentation tools to incorrectly associate this comment with the entire netLabelProps object instead of the inline property within it.

The comment should either be:

  1. Placed inside the interface before line 3228 (inline?: boolean), or
  2. Placed inside the zod schema before line 3243 (inline: z.boolean().optional())

This suggests the generation script generate-component-types.ts may have a bug in how it positions JSDoc comments for new properties.

Spotted by Graphite

Fix in Graphite


Is this helpful? React 👍 or 👎 to let us know.

@tscircuitbot

Copy link
Copy Markdown
Contributor

Thank you for your contribution! 🎉

PR Rating: ⭐⭐
Impact: Minor

Track your contributions and see the leaderboard at: tscircuit Contribution Tracker


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants