@tscircuit/props 0.0.697 → 0.0.699
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +164 -112
- package/dist/index.d.ts +20026 -2704
- package/dist/index.js +1544 -1375
- package/dist/index.js.map +1 -1
- package/lib/assembly/bolt.ts +79 -0
- package/lib/assembly/fastener.ts +78 -0
- package/lib/assembly/index.ts +6 -0
- package/lib/components/pcb-return-current-excitation.ts +110 -0
- package/lib/components/pcb-return-current-simulation.ts +25 -0
- package/lib/index.ts +1 -0
- package/lib/simulation/index.ts +10 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,118 +20,120 @@ resistorProps.parse({ resistance: "10k" } as ResistorPropsInput);
|
|
|
20
20
|
|
|
21
21
|
## Available Components
|
|
22
22
|
|
|
23
|
-
| Component
|
|
24
|
-
|
|
|
25
|
-
| `<ammeter />`
|
|
26
|
-
| `<analog.acsweepsimulation />`
|
|
27
|
-
| `<analog.dcoperatingpointsimulation />`
|
|
28
|
-
| `<analog.dcsweepsimulation />`
|
|
29
|
-
| `<analogsimulation />`
|
|
30
|
-
| `<analog.sweepparameter />`
|
|
31
|
-
| `<analog.transientsimulation />`
|
|
32
|
-
| `<antenna />`
|
|
33
|
-
| `<autoroutingphase />`
|
|
34
|
-
| `<battery />`
|
|
35
|
-
| `<board />`
|
|
36
|
-
| `<breakout />`
|
|
37
|
-
| `<breakoutpoint />`
|
|
38
|
-
| `<bus />`
|
|
39
|
-
| `<cadassembly />`
|
|
40
|
-
| `<cadmodel />`
|
|
41
|
-
| `<capacitor />`
|
|
42
|
-
| `<chip />`
|
|
43
|
-
| `<connector />`
|
|
44
|
-
| `<constrainedlayout />`
|
|
45
|
-
| `<constraint />`
|
|
46
|
-
| `<copperpour />`
|
|
47
|
-
| `<coppertext />`
|
|
48
|
-
| `<courtyardcircle />`
|
|
49
|
-
| `<courtyardoutline />`
|
|
50
|
-
| `<courtyardpill />`
|
|
51
|
-
| `<courtyardrect />`
|
|
52
|
-
| `<crystal />`
|
|
53
|
-
| `<currentsource />`
|
|
54
|
-
| `<cutout />`
|
|
55
|
-
| `<differentialpair />`
|
|
56
|
-
| `<diode />`
|
|
57
|
-
| `<drccheck />`
|
|
58
|
-
| `<fabricationnotedimension />`
|
|
59
|
-
| `<fabricationnotepath />`
|
|
60
|
-
| `<fabricationnoterect />`
|
|
61
|
-
| `<fabricationnotetext />`
|
|
62
|
-
| `<fiducial />`
|
|
63
|
-
| `<footprint />`
|
|
64
|
-
| `<fuse />`
|
|
65
|
-
| `<group />`
|
|
66
|
-
| `<hole />`
|
|
67
|
-
| `<inductor />`
|
|
68
|
-
| `<interconnect />`
|
|
69
|
-
| `<internalcircuit />`
|
|
70
|
-
| `<jumper />`
|
|
71
|
-
| `<led />`
|
|
72
|
-
| `<mosfet />`
|
|
73
|
-
| `<mountedboard />`
|
|
74
|
-
| `<net />`
|
|
75
|
-
| `<netalias />`
|
|
76
|
-
| `<netlabel />`
|
|
77
|
-
| `<opamp />`
|
|
78
|
-
| `<panel />`
|
|
79
|
-
| `<pcbbend />`
|
|
80
|
-
| `<pcbkeepout />`
|
|
81
|
-
| `<pcbnotedimension />`
|
|
82
|
-
| `<pcbnoteline />`
|
|
83
|
-
| `<pcbnotepath />`
|
|
84
|
-
| `<pcbnoterect />`
|
|
85
|
-
| `<pcbnotetext />`
|
|
86
|
-
| `<
|
|
87
|
-
| `<
|
|
88
|
-
| `<
|
|
89
|
-
| `<
|
|
90
|
-
| `<
|
|
91
|
-
| `<
|
|
92
|
-
| `<
|
|
93
|
-
| `<
|
|
94
|
-
| `<
|
|
95
|
-
| `<
|
|
96
|
-
| `<
|
|
97
|
-
| `<
|
|
98
|
-
| `<
|
|
99
|
-
| `<
|
|
100
|
-
| `<
|
|
101
|
-
| `<
|
|
102
|
-
| `<
|
|
103
|
-
| `<
|
|
104
|
-
| `<
|
|
105
|
-
| `<
|
|
106
|
-
| `<
|
|
107
|
-
| `<
|
|
108
|
-
| `<
|
|
109
|
-
| `<
|
|
110
|
-
| `<
|
|
111
|
-
| `<
|
|
112
|
-
| `<
|
|
113
|
-
| `<
|
|
114
|
-
| `<
|
|
115
|
-
| `<
|
|
116
|
-
| `<
|
|
117
|
-
| `<
|
|
118
|
-
| `<
|
|
119
|
-
| `<
|
|
120
|
-
| `<
|
|
121
|
-
| `<
|
|
122
|
-
| `<
|
|
123
|
-
| `<
|
|
124
|
-
| `<
|
|
125
|
-
| `<
|
|
126
|
-
| `<
|
|
127
|
-
| `<
|
|
128
|
-
| `<
|
|
129
|
-
| `<
|
|
130
|
-
| `<
|
|
131
|
-
| `<
|
|
132
|
-
| `<
|
|
133
|
-
| `<
|
|
134
|
-
| `<
|
|
23
|
+
| Component | Props Interface |
|
|
24
|
+
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
|
|
25
|
+
| `<ammeter />` | [`AmmeterProps`](#ammeterprops-ammeter) |
|
|
26
|
+
| `<analog.acsweepsimulation />` | [`AnalogAcSweepSimulationProps`](#analogacsweepsimulationprops-analogacsweepsimulation) |
|
|
27
|
+
| `<analog.dcoperatingpointsimulation />` | [`AnalogDcOperatingPointSimulationProps`](#analogdcoperatingpointsimulationprops-analogdcoperatingpointsimulation) |
|
|
28
|
+
| `<analog.dcsweepsimulation />` | [`AnalogDcSweepSimulationProps`](#analogdcsweepsimulationprops-analogdcsweepsimulation) |
|
|
29
|
+
| `<analogsimulation />` | [`AnalogSimulationProps`](#analogsimulationprops-analogsimulation) |
|
|
30
|
+
| `<analog.sweepparameter />` | [`AnalogResistanceSweepParameterProps`](#analogresistancesweepparameterprops-analogsweepparameter) |
|
|
31
|
+
| `<analog.transientsimulation />` | [`AnalogTransientSimulationProps`](#analogtransientsimulationprops-analogtransientsimulation) |
|
|
32
|
+
| `<antenna />` | [`AntennaProps`](#antennaprops-antenna) |
|
|
33
|
+
| `<autoroutingphase />` | [`AutoroutingPhaseProps`](#autoroutingphaseprops-autoroutingphase) |
|
|
34
|
+
| `<battery />` | [`BatteryProps`](#batteryprops-battery) |
|
|
35
|
+
| `<board />` | [`BoardProps`](#boardprops-board) |
|
|
36
|
+
| `<breakout />` | [`BreakoutProps`](#breakoutprops-breakout) |
|
|
37
|
+
| `<breakoutpoint />` | [`BreakoutPointProps`](#breakoutpointprops-breakoutpoint) |
|
|
38
|
+
| `<bus />` | [`BusProps`](#busprops-bus) |
|
|
39
|
+
| `<cadassembly />` | [`CadAssemblyProps`](#cadassemblyprops-cadassembly) |
|
|
40
|
+
| `<cadmodel />` | [`CadModelProps`](#cadmodelprops-cadmodel) |
|
|
41
|
+
| `<capacitor />` | [`CapacitorProps`](#capacitorprops-capacitor) |
|
|
42
|
+
| `<chip />` | [`ChipProps`](#chipprops-chip) |
|
|
43
|
+
| `<connector />` | [`ConnectorProps`](#connectorprops-connector) |
|
|
44
|
+
| `<constrainedlayout />` | [`ConstrainedLayoutProps`](#constrainedlayoutprops-constrainedlayout) |
|
|
45
|
+
| `<constraint />` | [`ConstraintProps`](#constraintprops-constraint) |
|
|
46
|
+
| `<copperpour />` | [`CopperPourProps`](#copperpourprops-copperpour) |
|
|
47
|
+
| `<coppertext />` | [`CopperTextProps`](#coppertextprops-coppertext) |
|
|
48
|
+
| `<courtyardcircle />` | [`CourtyardCircleProps`](#courtyardcircleprops-courtyardcircle) |
|
|
49
|
+
| `<courtyardoutline />` | [`CourtyardOutlineProps`](#courtyardoutlineprops-courtyardoutline) |
|
|
50
|
+
| `<courtyardpill />` | [`CourtyardPillProps`](#courtyardpillprops-courtyardpill) |
|
|
51
|
+
| `<courtyardrect />` | [`CourtyardRectProps`](#courtyardrectprops-courtyardrect) |
|
|
52
|
+
| `<crystal />` | [`CrystalProps`](#crystalprops-crystal) |
|
|
53
|
+
| `<currentsource />` | [`CurrentSourceProps`](#currentsourceprops-currentsource) |
|
|
54
|
+
| `<cutout />` | [`RectCutoutProps`](#rectcutoutprops-cutout) |
|
|
55
|
+
| `<differentialpair />` | [`DifferentialPairProps`](#differentialpairprops-differentialpair) |
|
|
56
|
+
| `<diode />` | [`DiodeProps`](#diodeprops-diode) |
|
|
57
|
+
| `<drccheck />` | [`DrcCheckProps`](#drccheckprops-drccheck) |
|
|
58
|
+
| `<fabricationnotedimension />` | [`FabricationNoteDimensionProps`](#fabricationnotedimensionprops-fabricationnotedimension) |
|
|
59
|
+
| `<fabricationnotepath />` | [`FabricationNotePathProps`](#fabricationnotepathprops-fabricationnotepath) |
|
|
60
|
+
| `<fabricationnoterect />` | [`FabricationNoteRectProps`](#fabricationnoterectprops-fabricationnoterect) |
|
|
61
|
+
| `<fabricationnotetext />` | [`FabricationNoteTextProps`](#fabricationnotetextprops-fabricationnotetext) |
|
|
62
|
+
| `<fiducial />` | [`FiducialProps`](#fiducialprops-fiducial) |
|
|
63
|
+
| `<footprint />` | [`FootprintProps`](#footprintprops-footprint) |
|
|
64
|
+
| `<fuse />` | [`FuseProps`](#fuseprops-fuse) |
|
|
65
|
+
| `<group />` | [`BaseGroupProps`](#basegroupprops-group) |
|
|
66
|
+
| `<hole />` | [`CircleHoleProps`](#circleholeprops-hole) |
|
|
67
|
+
| `<inductor />` | [`InductorProps`](#inductorprops-inductor) |
|
|
68
|
+
| `<interconnect />` | [`InterconnectProps`](#interconnectprops-interconnect) |
|
|
69
|
+
| `<internalcircuit />` | [`InternalCircuitProps`](#internalcircuitprops-internalcircuit) |
|
|
70
|
+
| `<jumper />` | [`JumperProps`](#jumperprops-jumper) |
|
|
71
|
+
| `<led />` | [`LedProps`](#ledprops-led) |
|
|
72
|
+
| `<mosfet />` | [`MosfetProps`](#mosfetprops-mosfet) |
|
|
73
|
+
| `<mountedboard />` | [`MountedBoardProps`](#mountedboardprops-mountedboard) |
|
|
74
|
+
| `<net />` | [`NetProps`](#netprops-net) |
|
|
75
|
+
| `<netalias />` | [`NetAliasProps`](#netaliasprops-netalias) |
|
|
76
|
+
| `<netlabel />` | [`NetLabelProps`](#netlabelprops-netlabel) |
|
|
77
|
+
| `<opamp />` | [`OpAmpProps`](#opampprops-opamp) |
|
|
78
|
+
| `<panel />` | [`PanelProps`](#panelprops-panel) |
|
|
79
|
+
| `<pcbbend />` | [`PcbBendProps`](#pcbbendprops-pcbbend) |
|
|
80
|
+
| `<pcbkeepout />` | [`PcbKeepoutProps`](#pcbkeepoutprops-pcbkeepout) |
|
|
81
|
+
| `<pcbnotedimension />` | [`PcbNoteDimensionProps`](#pcbnotedimensionprops-pcbnotedimension) |
|
|
82
|
+
| `<pcbnoteline />` | [`PcbNoteLineProps`](#pcbnotelineprops-pcbnoteline) |
|
|
83
|
+
| `<pcbnotepath />` | [`PcbNotePathProps`](#pcbnotepathprops-pcbnotepath) |
|
|
84
|
+
| `<pcbnoterect />` | [`PcbNoteRectProps`](#pcbnoterectprops-pcbnoterect) |
|
|
85
|
+
| `<pcbnotetext />` | [`PcbNoteTextProps`](#pcbnotetextprops-pcbnotetext) |
|
|
86
|
+
| `<simulation.pcbreturncurrentexcitation />` | [`PcbReturnCurrentExcitationProps`](#pcbreturncurrentexcitationprops-simulationpcbreturncurrentexcitation) |
|
|
87
|
+
| `<simulation.pcbreturncurrentsimulation />` | [`PcbReturnCurrentSimulationProps`](#pcbreturncurrentsimulationprops-simulationpcbreturncurrentsimulation) |
|
|
88
|
+
| `<pcbsoldermaskopening />` | [`PcbSoldermaskOpeningProps`](#pcbsoldermaskopeningprops-pcbsoldermaskopening) |
|
|
89
|
+
| `<pcbstiffener />` | [`PcbStiffenerProps`](#pcbstiffenerprops-pcbstiffener) |
|
|
90
|
+
| `<pcbtrace />` | [`PcbTraceProps`](#pcbtraceprops-pcbtrace) |
|
|
91
|
+
| `<pinheader />` | [`PinHeaderProps`](#pinheaderprops-pinheader) |
|
|
92
|
+
| `<pinout />` | [`PinoutProps`](#pinoutprops-pinout) |
|
|
93
|
+
| `<platedhole />` | [`CirclePlatedHoleProps`](#circleplatedholeprops-platedhole) |
|
|
94
|
+
| `<port />` | [`PortProps`](#portprops-port) |
|
|
95
|
+
| `<potentiometer />` | [`PotentiometerProps`](#potentiometerprops-potentiometer) |
|
|
96
|
+
| `<powersource />` | [`PowerSourceProps`](#powersourceprops-powersource) |
|
|
97
|
+
| `<pushbutton />` | [`PushButtonProps`](#pushbuttonprops-pushbutton) |
|
|
98
|
+
| `<resistor />` | [`ResistorProps`](#resistorprops-resistor) |
|
|
99
|
+
| `<resonator />` | [`ResonatorProps`](#resonatorprops-resonator) |
|
|
100
|
+
| `<schematicarc />` | [`SchematicArcProps`](#schematicarcprops-schematicarc) |
|
|
101
|
+
| `<schematicbox />` | [`SchematicBoxProps`](#schematicboxprops-schematicbox) |
|
|
102
|
+
| `<schematiccell />` | [`SchematicCellProps`](#schematiccellprops-schematiccell) |
|
|
103
|
+
| `<schematiccircle />` | [`SchematicCircleProps`](#schematiccircleprops-schematiccircle) |
|
|
104
|
+
| `<schematicgraphic />` | [`SchematicGraphicProps`](#schematicgraphicprops-schematicgraphic) |
|
|
105
|
+
| `<schematicline />` | [`SchematicLineProps`](#schematiclineprops-schematicline) |
|
|
106
|
+
| `<schematicpath />` | [`SchematicPathProps`](#schematicpathprops-schematicpath) |
|
|
107
|
+
| `<schematicrect />` | [`SchematicRectProps`](#schematicrectprops-schematicrect) |
|
|
108
|
+
| `<schematicrow />` | [`SchematicRowProps`](#schematicrowprops-schematicrow) |
|
|
109
|
+
| `<schematicsection />` | [`SchematicSectionProps`](#schematicsectionprops-schematicsection) |
|
|
110
|
+
| `<schematicsheet />` | [`SchematicSheetProps`](#schematicsheetprops-schematicsheet) |
|
|
111
|
+
| `<schematicsymbol />` | [`SchematicSymbolProps`](#schematicsymbolprops-schematicsymbol) |
|
|
112
|
+
| `<schematictable />` | [`SchematicTableProps`](#schematictableprops-schematictable) |
|
|
113
|
+
| `<schematictext />` | [`SchematicTextProps`](#schematictextprops-schematictext) |
|
|
114
|
+
| `<silkscreencircle />` | [`SilkscreenCircleProps`](#silkscreencircleprops-silkscreencircle) |
|
|
115
|
+
| `<silkscreengraphic />` | [`SilkscreenGraphicProps`](#silkscreengraphicprops-silkscreengraphic) |
|
|
116
|
+
| `<silkscreenline />` | [`SilkscreenLineProps`](#silkscreenlineprops-silkscreenline) |
|
|
117
|
+
| `<silkscreenpath />` | [`SilkscreenPathProps`](#silkscreenpathprops-silkscreenpath) |
|
|
118
|
+
| `<silkscreenrect />` | [`SilkscreenRectProps`](#silkscreenrectprops-silkscreenrect) |
|
|
119
|
+
| `<silkscreentext />` | [`SilkscreenTextProps`](#silkscreentextprops-silkscreentext) |
|
|
120
|
+
| `<smtpad />` | [`RectSmtPadProps`](#rectsmtpadprops-smtpad) |
|
|
121
|
+
| `<solderjumper />` | [`SolderJumperProps`](#solderjumperprops-solderjumper) |
|
|
122
|
+
| `<solderpaste />` | [`RectSolderPasteProps`](#rectsolderpasteprops-solderpaste) |
|
|
123
|
+
| `<spicemodel />` | [`SpiceModelProps`](#spicemodelprops-spicemodel) |
|
|
124
|
+
| `<stampboard />` | [`StampboardProps`](#stampboardprops-stampboard) |
|
|
125
|
+
| `<subcircuit />` | [`SubcircuitProps`](#subcircuitprops-subcircuit) |
|
|
126
|
+
| `<subpanel />` | [`SubpanelProps`](#subpanelprops-subpanel) |
|
|
127
|
+
| `<switch />` | [`SwitchProps`](#switchprops-switch) |
|
|
128
|
+
| `<symbol />` | [`SymbolProps`](#symbolprops-symbol) |
|
|
129
|
+
| `<testpoint />` | [`TestpointProps`](#testpointprops-testpoint) |
|
|
130
|
+
| `<toolingrail />` | [`ToolingrailProps`](#toolingrailprops-toolingrail) |
|
|
131
|
+
| `<trace />` | [`TraceProps`](#traceprops-trace) |
|
|
132
|
+
| `<tracehint />` | [`TraceHintProps`](#tracehintprops-tracehint) |
|
|
133
|
+
| `<transistor />` | [`TransistorProps`](#transistorprops-transistor) |
|
|
134
|
+
| `<via />` | [`ViaProps`](#viaprops-via) |
|
|
135
|
+
| `<voltageprobe />` | [`VoltageProbeProps`](#voltageprobeprops-voltageprobe) |
|
|
136
|
+
| `<voltagesource />` | [`VoltageSourceProps`](#voltagesourceprops-voltagesource) |
|
|
135
137
|
|
|
136
138
|
<!-- COMPONENT_TABLE_END -->
|
|
137
139
|
|
|
@@ -1707,6 +1709,56 @@ export interface PcbNoteTextProps extends PcbLayoutProps {
|
|
|
1707
1709
|
|
|
1708
1710
|
[Source](https://github.com/tscircuit/props/blob/main/lib/components/pcb-note-text.ts)
|
|
1709
1711
|
|
|
1712
|
+
<a id="pcbreturncurrentexcitationprops-simulationpcbreturncurrentexcitation"></a>
|
|
1713
|
+
|
|
1714
|
+
### PcbReturnCurrentExcitationProps `<simulation.pcbreturncurrentexcitation />`
|
|
1715
|
+
|
|
1716
|
+
```ts
|
|
1717
|
+
export interface PcbReturnCurrentExcitationProps {
|
|
1718
|
+
/** Readable excitation name for diagnostics; not stored on its Circuit JSON record. */
|
|
1719
|
+
name?: string;
|
|
1720
|
+
/** Signal driver port selector, e.g. ".U1 > .OUT". */
|
|
1721
|
+
source: string;
|
|
1722
|
+
/** Signal receiving port selector, e.g. ".U2 > .IN". */
|
|
1723
|
+
load: string;
|
|
1724
|
+
/** Ground net selector, e.g. "net.GND"; its copper and connections must already exist. */
|
|
1725
|
+
ground: string;
|
|
1726
|
+
/** Positive in-phase peak signal current. Numbers are amperes, not RMS; strings use ampere units. */
|
|
1727
|
+
current: number | string;
|
|
1728
|
+
/** Load-side GND port where positive return current enters the return conductor. */
|
|
1729
|
+
returnSource: string;
|
|
1730
|
+
/** Driver-side GND port where positive return current leaves the return conductor. */
|
|
1731
|
+
returnSink: string;
|
|
1732
|
+
/** Positive real source-port resistance. Numbers are ohms; complex impedances are unsupported. */
|
|
1733
|
+
sourceImpedance: number | string;
|
|
1734
|
+
/** Positive real load-port resistance. Numbers are ohms; complex impedances are unsupported. */
|
|
1735
|
+
loadImpedance: number | string;
|
|
1736
|
+
/** Optional trace selector to disambiguate multiple routes between the signal ports. */
|
|
1737
|
+
trace?: string;
|
|
1738
|
+
/** Contact layer for a load-side PCB port spanning multiple copper layers. */
|
|
1739
|
+
returnSourceLayer?: LayerRefInput;
|
|
1740
|
+
/** Contact layer for a driver-side PCB port spanning multiple copper layers. */
|
|
1741
|
+
returnSinkLayer?: LayerRefInput;
|
|
1742
|
+
}
|
|
1743
|
+
```
|
|
1744
|
+
|
|
1745
|
+
[Source](https://github.com/tscircuit/props/blob/main/lib/components/pcb-return-current-excitation.ts)
|
|
1746
|
+
|
|
1747
|
+
<a id="pcbreturncurrentsimulationprops-simulationpcbreturncurrentsimulation"></a>
|
|
1748
|
+
|
|
1749
|
+
### PcbReturnCurrentSimulationProps `<simulation.pcbreturncurrentsimulation />`
|
|
1750
|
+
|
|
1751
|
+
```ts
|
|
1752
|
+
export interface PcbReturnCurrentSimulationProps {
|
|
1753
|
+
/** Stable identity and readable name for the experiment. */
|
|
1754
|
+
name?: string;
|
|
1755
|
+
/** One or more nested simulation.pcbreturncurrentexcitation elements. */
|
|
1756
|
+
children?: ReactNode;
|
|
1757
|
+
}
|
|
1758
|
+
```
|
|
1759
|
+
|
|
1760
|
+
[Source](https://github.com/tscircuit/props/blob/main/lib/components/pcb-return-current-simulation.ts)
|
|
1761
|
+
|
|
1710
1762
|
### PcbSoldermaskOpeningProps `<pcbsoldermaskopening />`
|
|
1711
1763
|
|
|
1712
1764
|
```ts
|