From 41100e7ace3f4538917fdefe4c5aa80584cfce20 Mon Sep 17 00:00:00 2001 From: victorhblancom-design Date: Fri, 29 May 2026 02:41:24 -0600 Subject: [PATCH 1/3] docs: add built-in elements overview --- docs/elements/index.mdx | 116 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 docs/elements/index.mdx diff --git a/docs/elements/index.mdx b/docs/elements/index.mdx new file mode 100644 index 00000000..3cf7fef0 --- /dev/null +++ b/docs/elements/index.mdx @@ -0,0 +1,116 @@ +--- +title: Built-in Elements +sidebar_label: Overview +description: A curated map of every built-in tscircuit element, grouped by the job it does. +sidebar_position: 0 +--- + +The built-in elements are the JSX primitives that make up a tscircuit design. +Use this page as a map: start with ``, place real parts like +``, ``, and ``, then add routing, footprint, +schematic, and annotation elements as the design needs more detail. + +If you are looking for the old `` element, use [``](./chip.mdx) +instead. `` is the general-purpose component for ICs, modules, and other +single-package parts with custom pin labels or footprints. + +## Core Circuit Structure + +| Element | Use it for | +| --- | --- | +| [``](./board.mdx) | The root PCB area, board size, layout, and autorouting settings. | +| [``](./group.mdx) | Grouping components so they can be laid out and referenced together. | +| [``](./subcircuit.mdx) | Reusable circuit sections with their own layout and routing context. | +| [``](./port.mdx) | Named connection points inside custom components, symbols, and footprints. | +| [``](./net.mdx) | A named electrical net that multiple component pins can connect to. | +| [``](./netlabel.mdx) | Schematic labels that expose or clarify named nets. | +| [``](./trace.mdx) | Explicit electrical connections between ports or selectors. | + +## Components + +| Element | Use it for | +| --- | --- | +| [``](./chip.mdx) | General-purpose ICs, modules, sensors, and any single-package component with custom pins. | +| [``](./resistor.mdx) | Fixed resistors, pull-ups, pull-downs, and current limiting. | +| [``](./capacitor.mdx) | Decoupling, filtering, timing, and bulk capacitance. | +| [``](./inductor.mdx) | Power filtering, LC filters, and switching regulator magnetics. | +| [``](./diode.mdx) | Directional current flow, flyback paths, clamps, and rectification. | +| [``](./led.mdx) | Indicator LEDs and light-emitting diode symbols. | +| [``](./fuse.mdx) | Resettable or one-time overcurrent protection. | +| [``](./crystal.mdx) | Quartz crystal timing references. | +| [``](./resonator.mdx) | Ceramic resonator timing references. | +| [``](./switch.mdx) | Generic switches and user-controlled circuit breaks. | +| [``](./pushbutton.mdx) | Momentary button inputs. | +| [``](./potentiometer.mdx) | Adjustable resistors and voltage dividers. | +| [``](./transistor.mdx) | Generic bipolar transistor symbols and packages. | +| [``](./mosfet.mdx) | MOSFET switches and transistor-level power control. | +| [``](./opamp.mdx) | Operational amplifiers with standard op-amp pin behavior. | +| [``](./battery.mdx) | Battery sources and battery holder style components. | +| [``](./voltagesource.mdx) | Ideal voltage sources for schematic and simulation contexts. | +| [``](./voltageprobe.mdx) | Simulation probes for measuring circuit voltage. | + +## Connectors And Breakouts + +| Element | Use it for | +| --- | --- | +| [``](./connector.mdx) | USB, M.2, board-to-board, cable, and custom connector parts. | +| [``](./pinheader.mdx) | Standard through-hole or surface-mount pin headers. | +| [``](./jumper.mdx) | Removable or configurable jumper links. | +| [``](./solderjumper.mdx) | PCB solder jumpers and configurable copper bridges. | +| [``](./testpoint.mdx) | Probe pads for test, programming, and debug access. | +| [``](./breakout.mdx) | Fan-out areas where signals leave a dense component. | +| [``](./breakoutpoint.mdx) | Individual breakout targets inside a ``. | + +## PCB And Footprint Detail + +| Element | Use it for | +| --- | --- | +| [``](./footprint.mdx) | Custom footprint definitions built from pads, holes, and geometry. | +| [``](./cadmodel.mdx) | 3D models attached to packages or assemblies. | +| [``](./cadassembly.mdx) | Grouping CAD models that belong to a component or assembly. | +| [``](./hole.mdx) | Mechanical, mounting, and through-hole footprint holes. | +| [``](./via.mdx) | PCB layer transitions for routed traces. | +| [``](./copperpour.mdx) | Copper fill regions tied to a net. | +| [``](./coppertext.mdx) | Text rendered as copper on the PCB. | +| [``](./cutout.mdx) | Board slots, keep-outs, and routed material removal. | +| [``](./fiducial.mdx) | Pick-and-place optical reference marks. | + +## Courtyards + +| Element | Use it for | +| --- | --- | +| [``](./courtyardrect.mdx) | Rectangular component courtyard boundaries. | +| [``](./courtyardcircle.mdx) | Circular courtyard boundaries. | +| [``](./courtyardoutline.mdx) | Custom courtyard outlines. | + +## Schematic Drawing + +| Element | Use it for | +| --- | --- | +| [``](./symbol.mdx) | Custom schematic symbols composed from drawing primitives. | +| [``](./schematicline.mdx) | Straight schematic drawing lines. | +| [``](./schematicpath.mdx) | Multi-segment schematic paths. | +| [``](./schematicarc.mdx) | Arc segments in custom symbols and drawings. | +| [``](./schematiccircle.mdx) | Circular schematic drawing primitives. | +| [``](./schematicrect.mdx) | Rectangular schematic drawing primitives. | +| [``](./schematictext.mdx) | Text labels inside schematics or custom symbols. | +| [``](./schematicsection.mdx) | Visual schematic sections and group boundaries. | +| [``](./schematictable.mdx) | Tabular schematic annotations. | + +## PCB Notes + +| Element | Use it for | +| --- | --- | +| [``](./pcbnotedimension.mdx) | Dimension callouts on PCB documentation layers. | +| [``](./pcbnoteline.mdx) | Line annotations on PCB documentation layers. | +| [``](./pcbnotepath.mdx) | Path annotations on PCB documentation layers. | +| [``](./pcbnoterect.mdx) | Rectangular PCB note annotations. | +| [``](./pcbnotetext.mdx) | Text annotations on PCB documentation layers. | + +## Analysis And Routing + +| Element | Use it for | +| --- | --- | +| [``](./analogsimulation.mdx) | Analog simulation setup and outputs. | +| [``](./autoroutingphase.mdx) | Inspecting and controlling stages of autorouting. | + From 64e00e5f5efb8e4d46683b6d339af488f1297df9 Mon Sep 17 00:00:00 2001 From: victorhblancom-design Date: Fri, 29 May 2026 02:41:39 -0600 Subject: [PATCH 2/3] docs: route elements category to overview --- docs/elements/_category_.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/elements/_category_.json b/docs/elements/_category_.json index 032fcae9..03ad136a 100644 --- a/docs/elements/_category_.json +++ b/docs/elements/_category_.json @@ -2,8 +2,8 @@ "label": "Built-in Elements", "position": 5, "link": { - "type": "generated-index", - "description": "Learn how to use the builtin tscircuit elements" + "type": "doc", + "id": "index" }, "collapsible": true, "collapsed": false From 0919cd414a8d4bbda0a4e07328338302a18e03c7 Mon Sep 17 00:00:00 2001 From: victorhblancom-design Date: Fri, 29 May 2026 02:41:47 -0600 Subject: [PATCH 3/3] docs: clarify chip replaces bug element --- docs/elements/chip.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/elements/chip.mdx b/docs/elements/chip.mdx index 5b4561ea..cd901ebc 100644 --- a/docs/elements/chip.mdx +++ b/docs/elements/chip.mdx @@ -11,6 +11,12 @@ The `` is the most common and most powerful built-in tscircuit element. You can represent virtually any "single-part" electronic component with ``, it is extremely flexible. +:::tip Migrating from `` +Older examples may refer to a `` element. Use `` for that role +in current tscircuit projects; it is the supported element for ICs, modules, and +other single-package parts with named pins. +::: + ## Simple Chips Here's an example of typical `` usage. We specify a footprint string and