@tscircuit/props 0.0.292 → 0.0.294
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 +18 -0
- package/dist/index.d.ts +26 -1
- package/dist/index.js +546 -537
- package/dist/index.js.map +1 -1
- package/lib/components/board.ts +3 -0
- package/lib/components/symbol.ts +23 -0
- package/lib/index.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -55,6 +55,7 @@ resistorProps.parse({ resistance: "10k" } as ResistorPropsInput);
|
|
|
55
55
|
| `<solderpaste />` | [`RectSolderPasteProps`](#rectsolderpasteprops-solderpaste) |
|
|
56
56
|
| `<stampboard />` | [`StampboardProps`](#stampboardprops-stampboard) |
|
|
57
57
|
| `<switch />` | [`SwitchProps`](#switchprops-switch) |
|
|
58
|
+
| `<symbol />` | [`SymbolProps`](#symbolprops-symbol) |
|
|
58
59
|
| `<testpoint />` | [`TestpointProps`](#testpointprops-testpoint) |
|
|
59
60
|
| `<transistor />` | [`TransistorProps`](#transistorprops-transistor) |
|
|
60
61
|
| `<via />` | [`ViaProps`](#viaprops-via) |
|
|
@@ -160,6 +161,7 @@ export interface BoardProps extends Omit<SubcircuitGroupProps, "subcircuit"> {
|
|
|
160
161
|
material?: "fr4" | "fr1";
|
|
161
162
|
/** Number of layers for the PCB */
|
|
162
163
|
layers?: 2 | 4;
|
|
164
|
+
borderRadius?: Distance;
|
|
163
165
|
}
|
|
164
166
|
```
|
|
165
167
|
|
|
@@ -888,6 +890,22 @@ export interface SwitchProps extends CommonComponentProps {
|
|
|
888
890
|
|
|
889
891
|
[Source](https://github.com/tscircuit/props/blob/main/lib/components/switch.ts)
|
|
890
892
|
|
|
893
|
+
### SymbolProps `<symbol />`
|
|
894
|
+
|
|
895
|
+
```ts
|
|
896
|
+
export interface SymbolProps {
|
|
897
|
+
/**
|
|
898
|
+
* The facing direction that the symbol is designed for. If you set this to "right",
|
|
899
|
+
* then it means the children were intended to represent the symbol facing right.
|
|
900
|
+
* Generally, you shouldn't set this except where it can help prevent confusion
|
|
901
|
+
* because you have a complex symbol. Default is "right" and this is most intuitive.
|
|
902
|
+
*/
|
|
903
|
+
originalFacingDirection?: "up" | "down" | "left" | "right";
|
|
904
|
+
}
|
|
905
|
+
```
|
|
906
|
+
|
|
907
|
+
[Source](https://github.com/tscircuit/props/blob/main/lib/components/symbol.ts)
|
|
908
|
+
|
|
891
909
|
### TestpointProps `<testpoint />`
|
|
892
910
|
|
|
893
911
|
```ts
|
package/dist/index.d.ts
CHANGED
|
@@ -7742,6 +7742,7 @@ interface BoardProps extends Omit<SubcircuitGroupProps, "subcircuit"> {
|
|
|
7742
7742
|
material?: "fr4" | "fr1";
|
|
7743
7743
|
/** Number of layers for the PCB */
|
|
7744
7744
|
layers?: 2 | 4;
|
|
7745
|
+
borderRadius?: Distance;
|
|
7745
7746
|
}
|
|
7746
7747
|
declare const boardProps: z.ZodObject<{
|
|
7747
7748
|
pcbX: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
|
|
@@ -8303,6 +8304,7 @@ declare const boardProps: z.ZodObject<{
|
|
|
8303
8304
|
} & {
|
|
8304
8305
|
material: z.ZodDefault<z.ZodEnum<["fr4", "fr1"]>>;
|
|
8305
8306
|
layers: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<2>, z.ZodLiteral<4>]>>;
|
|
8307
|
+
borderRadius: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
|
|
8306
8308
|
}, "strip", z.ZodTypeAny, {
|
|
8307
8309
|
material: "fr4" | "fr1";
|
|
8308
8310
|
layers: 2 | 4;
|
|
@@ -8539,6 +8541,7 @@ declare const boardProps: z.ZodObject<{
|
|
|
8539
8541
|
}[] | undefined;
|
|
8540
8542
|
outlineOffsetX?: number | undefined;
|
|
8541
8543
|
outlineOffsetY?: number | undefined;
|
|
8544
|
+
borderRadius?: number | undefined;
|
|
8542
8545
|
}, {
|
|
8543
8546
|
pcbX?: string | number | undefined;
|
|
8544
8547
|
pcbY?: string | number | undefined;
|
|
@@ -8779,6 +8782,7 @@ declare const boardProps: z.ZodObject<{
|
|
|
8779
8782
|
outlineOffsetY?: string | number | undefined;
|
|
8780
8783
|
material?: "fr4" | "fr1" | undefined;
|
|
8781
8784
|
layers?: 2 | 4 | undefined;
|
|
8785
|
+
borderRadius?: string | number | undefined;
|
|
8782
8786
|
}>;
|
|
8783
8787
|
|
|
8784
8788
|
interface BreakoutProps extends Omit<SubcircuitGroupProps, "subcircuit"> {
|
|
@@ -18365,6 +18369,7 @@ declare const stampboardProps: z.ZodObject<{
|
|
|
18365
18369
|
} & {
|
|
18366
18370
|
material: z.ZodDefault<z.ZodEnum<["fr4", "fr1"]>>;
|
|
18367
18371
|
layers: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<2>, z.ZodLiteral<4>]>>;
|
|
18372
|
+
borderRadius: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodNumber]>, number, string | number>>;
|
|
18368
18373
|
} & {
|
|
18369
18374
|
leftPinCount: z.ZodOptional<z.ZodNumber>;
|
|
18370
18375
|
rightPinCount: z.ZodOptional<z.ZodNumber>;
|
|
@@ -18616,6 +18621,7 @@ declare const stampboardProps: z.ZodObject<{
|
|
|
18616
18621
|
}[] | undefined;
|
|
18617
18622
|
outlineOffsetX?: number | undefined;
|
|
18618
18623
|
outlineOffsetY?: number | undefined;
|
|
18624
|
+
borderRadius?: number | undefined;
|
|
18619
18625
|
leftPins?: string[] | undefined;
|
|
18620
18626
|
rightPins?: string[] | undefined;
|
|
18621
18627
|
topPins?: string[] | undefined;
|
|
@@ -18866,6 +18872,7 @@ declare const stampboardProps: z.ZodObject<{
|
|
|
18866
18872
|
outlineOffsetY?: string | number | undefined;
|
|
18867
18873
|
material?: "fr4" | "fr1" | undefined;
|
|
18868
18874
|
layers?: 2 | 4 | undefined;
|
|
18875
|
+
borderRadius?: string | number | undefined;
|
|
18869
18876
|
leftPins?: string[] | undefined;
|
|
18870
18877
|
rightPins?: string[] | undefined;
|
|
18871
18878
|
topPins?: string[] | undefined;
|
|
@@ -20909,6 +20916,24 @@ declare const footprintProps: z.ZodObject<{
|
|
|
20909
20916
|
}>;
|
|
20910
20917
|
type FootprintPropsInput = z.input<typeof footprintProps>;
|
|
20911
20918
|
|
|
20919
|
+
interface SymbolProps {
|
|
20920
|
+
/**
|
|
20921
|
+
* The facing direction that the symbol is designed for. If you set this to "right",
|
|
20922
|
+
* then it means the children were intended to represent the symbol facing right.
|
|
20923
|
+
* Generally, you shouldn't set this except where it can help prevent confusion
|
|
20924
|
+
* because you have a complex symbol. Default is "right" and this is most intuitive.
|
|
20925
|
+
*/
|
|
20926
|
+
originalFacingDirection?: "up" | "down" | "left" | "right";
|
|
20927
|
+
}
|
|
20928
|
+
declare const symbolProps: z.ZodObject<{
|
|
20929
|
+
originalFacingDirection: z.ZodOptional<z.ZodDefault<z.ZodEnum<["up", "down", "left", "right"]>>>;
|
|
20930
|
+
}, "strip", z.ZodTypeAny, {
|
|
20931
|
+
originalFacingDirection?: "up" | "down" | "left" | "right" | undefined;
|
|
20932
|
+
}, {
|
|
20933
|
+
originalFacingDirection?: "up" | "down" | "left" | "right" | undefined;
|
|
20934
|
+
}>;
|
|
20935
|
+
type SymbolPropsInput = z.input<typeof symbolProps>;
|
|
20936
|
+
|
|
20912
20937
|
interface BatteryProps<PinLabel extends string = string> extends CommonComponentProps<PinLabel> {
|
|
20913
20938
|
capacity?: number | string;
|
|
20914
20939
|
voltage?: number | string;
|
|
@@ -30238,4 +30263,4 @@ interface PlatformConfig {
|
|
|
30238
30263
|
}
|
|
30239
30264
|
declare const platformConfig: z.ZodType<PlatformConfig>;
|
|
30240
30265
|
|
|
30241
|
-
export { type AutocompleteString, type AutorouterConfig, type AutorouterProp, type BaseGroupProps, type BaseManualEditEvent, type BaseManualEditEventInput, type BasicFootprint, type BatteryPinLabels, type BatteryProps, type BoardProps, type Border, type BreakoutPointProps, type BreakoutProps, type CadModelBase, type CadModelJscad, type CadModelObj, type CadModelProp, type CadModelStl, type CapacitorPinLabels, type CapacitorProps, type ChipConnections, type ChipPinLabels, type ChipProps, type ChipPropsSU, type CircleCutoutProps, type CirclePlatedHoleProps, type CircleSmtPadProps, type CircleSolderPasteProps, type CircularHoleWithRectPlatedProps, type CommonComponentProps, type CommonLayoutProps, type ComponentProps, type ConnectionTarget, type Connections, type ConnectorProps, type ConstrainedLayoutProps, type ConstraintProps, type CrystalPinLabels, type CrystalProps, type CutoutProps, type CutoutPropsInput, type DiodePinLabels, type DiodeProps, type Direction, type DirectionAlongEdge, type EditPcbComponentLocationEvent, type EditPcbComponentLocationEventInput, type EditPcbGroupLocationEvent, type EditPcbGroupLocationEventInput, type EditSchematicComponentLocationEvent, type EditSchematicComponentLocationEventInput, type EditSchematicGroupLocationEvent, type EditSchematicGroupLocationEventInput, type EditTraceHintEvent, type EditTraceHintEventInput, type FabricationNotePathProps, type FabricationNoteTextProps, type FootprintProp, type FootprintProps, type FootprintPropsInput, type FootprintSoupElements, type FusePinLabels, type FuseProps, type GroupProps, type HoleProps, type InductorPinLabels, type InductorProps, type InferredChipProps, type InferredConstrainedLayoutProps, type InferredDiodeProps, type InferredFuseProps, type InferredHoleProps, type InferredSmtPadProps, type InferredSolderPasteProps, type InferredSwitchProps, type InferredTestpointProps, type InferredViaProps, type JumperProps, type LayoutConfig, type LedPinLabels, type LedProps, type ManualEditEvent, type ManualEditEventInput, type ManualEditsFile, type ManualEditsFileInput, type ManualPcbPlacement, type ManualPcbPlacementInput, type ManualSchematicPlacement, type ManualSchematicPlacementInput, type ManualTraceHint, type ManualTraceHintInput, type MosfetPinLabels, type MosfetProps, type NetAliasProps, type NetLabelProps, type NetProps, type NonSubcircuitGroupProps, type OvalPlatedHoleProps, type PartsEngine, type PcbKeepoutProps, type PcbLayoutProps, type PcbRouteCache, type PcbSameXConstraint, type PcbSameYConstraint, type PcbTraceProps, type PcbXDistConstraint, type PcbYDistConstraint, type PillPlatedHoleProps, type PillSmtPadProps, type PillWithRectPadPlatedHoleProps, type PinAttributeMap, type PinCompatibleVariant, type PinHeaderProps, type PinLabelFromPinLabelMap, type PinLabelsProp, type PinSideDefinition, type PinVariant, type PinoutProps, type PlatedHoleProps, type PlatformConfig, type PolygonCutoutProps, type PolygonSmtPadProps, type PortHints, type PortProps, type PotentiometerPinVariant, type PotentiometerProps, type PowerSourceProps, type PushButtonProps, type RectCutoutProps, type RectSmtPadProps, type RectSolderPasteProps, type ResistorPinLabels, type ResistorProps, type ResonatorPinVariant, type ResonatorProps, type RotatedRectSmtPadProps, type SchematicBoxProps, type SchematicCellProps, type SchematicLineProps, type SchematicOrientation, type SchematicPathProps, type SchematicPinArrangement, type SchematicPinArrangementWithPinCounts, type SchematicPinArrangementWithSides, type SchematicPinArrangementWithSizes, type SchematicPinLabel, type SchematicPinStyle, type SchematicPortArrangement, type SchematicPortArrangementWithPinCounts, type SchematicPortArrangementWithSides, type SchematicPortArrangementWithSizes, type SchematicRowProps, type SchematicTableProps, type SchematicTextProps, type Selectors, type SilkscreenCircleProps, type SilkscreenLineProps, type SilkscreenPathProps, type SilkscreenRectProps, type SilkscreenTextProps, type SmtPadProps, type SolderJumperProps, type SolderPasteProps, type StampboardProps, type SubcircuitGroupProps, type SubcircuitGroupPropsWithBool, type SubcircuitProps, type SupplierName, type SupplierPartNumbers, type SupplierProps, type SwitchProps, type TestpointProps, type TraceHintProps, type TraceProps, type TransistorPinLabels, type TransistorProps, type ViaProps, type VoltageSourceProps, type WaveShape, autorouterConfig, autorouterProp, baseGroupProps, base_manual_edit_event, batteryPins, batteryProps, boardProps, border, breakoutPointProps, breakoutProps, bugProps, cadModelBase, cadModelJscad, cadModelObj, cadModelProp, cadModelStl, capacitorPinLabels, capacitorPins, capacitorProps, chipProps, circleCutoutProps, circleSmtPadProps, circleSolderPasteProps, commonComponentProps, commonLayoutProps, componentProps, connectorProps, constrainedLayoutProps, constraintProps, crystalPins, crystalProps, cutoutProps, diodePins, diodeProps, direction, directionAlongEdge, distanceOrMultiplier, edit_component_location_event, edit_pcb_component_location_event, edit_pcb_group_location_event, edit_schematic_component_location_event, edit_schematic_group_location_event, edit_trace_hint_event, explicitPinSideDefinition, fabricationNotePathProps, fabricationNoteTextProps, footprintProp, footprintProps, fusePinLabels, fuseProps, groupProps, holeProps, inductorPins, inductorProps, jumperProps, layoutConfig, ledPins, ledProps, lrPins, lrPolarPins, manual_edit_event, manual_edits_file, manual_pcb_placement, manual_schematic_placement, manual_trace_hint, mosfetPins, mosfetProps, netAliasProps, netLabelProps, netProps, ninePointAnchor, partsEngine, pcbKeepoutProps, pcbLayoutProps, pcbSameXConstraintProps, pcbSameYConstraintProps, pcbTraceProps, pcbXDistConstraintProps, pcbYDistConstraintProps, pillSmtPadProps, pinAttributeMap, pinCompatibleVariant, pinHeaderProps, pinLabelsProp, pinoutProps, platedHoleProps, platformConfig, point3, polygonCutoutProps, polygonSmtPadProps, portHints, portProps, portRef, potentiometerProps, powerSourceProps, pushButtonProps, rectCutoutProps, rectSmtPadProps, rectSolderPasteProps, resistorPinLabels, resistorPins, resistorProps, resonatorProps, rotatedRectSmtPadProps, rotationPoint3, routeHintPointProps, schematicBoxProps, schematicCellProps, schematicLineProps, schematicOrientation, schematicPathProps, schematicPinArrangement, schematicPinLabel, schematicPinStyle, schematicPortArrangement, schematicRowProps, schematicTableProps, schematicTextProps, silkscreenCircleProps, silkscreenLineProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, smtPadProps, solderPasteProps, solderjumperProps, stampboardProps, subcircuitGroupProps, subcircuitGroupPropsWithBool, subcircuitProps, supplierProps, switchProps, testpointProps, traceHintProps, traceProps, transistorPins, transistorPinsLabels, transistorProps, viaProps, voltageSourceProps };
|
|
30266
|
+
export { type AutocompleteString, type AutorouterConfig, type AutorouterProp, type BaseGroupProps, type BaseManualEditEvent, type BaseManualEditEventInput, type BasicFootprint, type BatteryPinLabels, type BatteryProps, type BoardProps, type Border, type BreakoutPointProps, type BreakoutProps, type CadModelBase, type CadModelJscad, type CadModelObj, type CadModelProp, type CadModelStl, type CapacitorPinLabels, type CapacitorProps, type ChipConnections, type ChipPinLabels, type ChipProps, type ChipPropsSU, type CircleCutoutProps, type CirclePlatedHoleProps, type CircleSmtPadProps, type CircleSolderPasteProps, type CircularHoleWithRectPlatedProps, type CommonComponentProps, type CommonLayoutProps, type ComponentProps, type ConnectionTarget, type Connections, type ConnectorProps, type ConstrainedLayoutProps, type ConstraintProps, type CrystalPinLabels, type CrystalProps, type CutoutProps, type CutoutPropsInput, type DiodePinLabels, type DiodeProps, type Direction, type DirectionAlongEdge, type EditPcbComponentLocationEvent, type EditPcbComponentLocationEventInput, type EditPcbGroupLocationEvent, type EditPcbGroupLocationEventInput, type EditSchematicComponentLocationEvent, type EditSchematicComponentLocationEventInput, type EditSchematicGroupLocationEvent, type EditSchematicGroupLocationEventInput, type EditTraceHintEvent, type EditTraceHintEventInput, type FabricationNotePathProps, type FabricationNoteTextProps, type FootprintProp, type FootprintProps, type FootprintPropsInput, type FootprintSoupElements, type FusePinLabels, type FuseProps, type GroupProps, type HoleProps, type InductorPinLabels, type InductorProps, type InferredChipProps, type InferredConstrainedLayoutProps, type InferredDiodeProps, type InferredFuseProps, type InferredHoleProps, type InferredSmtPadProps, type InferredSolderPasteProps, type InferredSwitchProps, type InferredTestpointProps, type InferredViaProps, type JumperProps, type LayoutConfig, type LedPinLabels, type LedProps, type ManualEditEvent, type ManualEditEventInput, type ManualEditsFile, type ManualEditsFileInput, type ManualPcbPlacement, type ManualPcbPlacementInput, type ManualSchematicPlacement, type ManualSchematicPlacementInput, type ManualTraceHint, type ManualTraceHintInput, type MosfetPinLabels, type MosfetProps, type NetAliasProps, type NetLabelProps, type NetProps, type NonSubcircuitGroupProps, type OvalPlatedHoleProps, type PartsEngine, type PcbKeepoutProps, type PcbLayoutProps, type PcbRouteCache, type PcbSameXConstraint, type PcbSameYConstraint, type PcbTraceProps, type PcbXDistConstraint, type PcbYDistConstraint, type PillPlatedHoleProps, type PillSmtPadProps, type PillWithRectPadPlatedHoleProps, type PinAttributeMap, type PinCompatibleVariant, type PinHeaderProps, type PinLabelFromPinLabelMap, type PinLabelsProp, type PinSideDefinition, type PinVariant, type PinoutProps, type PlatedHoleProps, type PlatformConfig, type PolygonCutoutProps, type PolygonSmtPadProps, type PortHints, type PortProps, type PotentiometerPinVariant, type PotentiometerProps, type PowerSourceProps, type PushButtonProps, type RectCutoutProps, type RectSmtPadProps, type RectSolderPasteProps, type ResistorPinLabels, type ResistorProps, type ResonatorPinVariant, type ResonatorProps, type RotatedRectSmtPadProps, type SchematicBoxProps, type SchematicCellProps, type SchematicLineProps, type SchematicOrientation, type SchematicPathProps, type SchematicPinArrangement, type SchematicPinArrangementWithPinCounts, type SchematicPinArrangementWithSides, type SchematicPinArrangementWithSizes, type SchematicPinLabel, type SchematicPinStyle, type SchematicPortArrangement, type SchematicPortArrangementWithPinCounts, type SchematicPortArrangementWithSides, type SchematicPortArrangementWithSizes, type SchematicRowProps, type SchematicTableProps, type SchematicTextProps, type Selectors, type SilkscreenCircleProps, type SilkscreenLineProps, type SilkscreenPathProps, type SilkscreenRectProps, type SilkscreenTextProps, type SmtPadProps, type SolderJumperProps, type SolderPasteProps, type StampboardProps, type SubcircuitGroupProps, type SubcircuitGroupPropsWithBool, type SubcircuitProps, type SupplierName, type SupplierPartNumbers, type SupplierProps, type SwitchProps, type SymbolProps, type SymbolPropsInput, type TestpointProps, type TraceHintProps, type TraceProps, type TransistorPinLabels, type TransistorProps, type ViaProps, type VoltageSourceProps, type WaveShape, autorouterConfig, autorouterProp, baseGroupProps, base_manual_edit_event, batteryPins, batteryProps, boardProps, border, breakoutPointProps, breakoutProps, bugProps, cadModelBase, cadModelJscad, cadModelObj, cadModelProp, cadModelStl, capacitorPinLabels, capacitorPins, capacitorProps, chipProps, circleCutoutProps, circleSmtPadProps, circleSolderPasteProps, commonComponentProps, commonLayoutProps, componentProps, connectorProps, constrainedLayoutProps, constraintProps, crystalPins, crystalProps, cutoutProps, diodePins, diodeProps, direction, directionAlongEdge, distanceOrMultiplier, edit_component_location_event, edit_pcb_component_location_event, edit_pcb_group_location_event, edit_schematic_component_location_event, edit_schematic_group_location_event, edit_trace_hint_event, explicitPinSideDefinition, fabricationNotePathProps, fabricationNoteTextProps, footprintProp, footprintProps, fusePinLabels, fuseProps, groupProps, holeProps, inductorPins, inductorProps, jumperProps, layoutConfig, ledPins, ledProps, lrPins, lrPolarPins, manual_edit_event, manual_edits_file, manual_pcb_placement, manual_schematic_placement, manual_trace_hint, mosfetPins, mosfetProps, netAliasProps, netLabelProps, netProps, ninePointAnchor, partsEngine, pcbKeepoutProps, pcbLayoutProps, pcbSameXConstraintProps, pcbSameYConstraintProps, pcbTraceProps, pcbXDistConstraintProps, pcbYDistConstraintProps, pillSmtPadProps, pinAttributeMap, pinCompatibleVariant, pinHeaderProps, pinLabelsProp, pinoutProps, platedHoleProps, platformConfig, point3, polygonCutoutProps, polygonSmtPadProps, portHints, portProps, portRef, potentiometerProps, powerSourceProps, pushButtonProps, rectCutoutProps, rectSmtPadProps, rectSolderPasteProps, resistorPinLabels, resistorPins, resistorProps, resonatorProps, rotatedRectSmtPadProps, rotationPoint3, routeHintPointProps, schematicBoxProps, schematicCellProps, schematicLineProps, schematicOrientation, schematicPathProps, schematicPinArrangement, schematicPinLabel, schematicPinStyle, schematicPortArrangement, schematicRowProps, schematicTableProps, schematicTextProps, silkscreenCircleProps, silkscreenLineProps, silkscreenPathProps, silkscreenRectProps, silkscreenTextProps, smtPadProps, solderPasteProps, solderjumperProps, stampboardProps, subcircuitGroupProps, subcircuitGroupPropsWithBool, subcircuitProps, supplierProps, switchProps, symbolProps, testpointProps, traceHintProps, traceProps, transistorPins, transistorPinsLabels, transistorProps, viaProps, voltageSourceProps };
|