@tscircuit/props 0.0.635 → 0.0.637
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 +20 -3
- package/dist/index.d.ts +705 -572
- package/dist/index.js +38 -0
- package/dist/index.js.map +1 -1
- package/lib/components/board.ts +78 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -365,10 +365,10 @@ export interface BatteryProps<
|
|
|
365
365
|
|
|
366
366
|
### BoardProps `<board />`
|
|
367
367
|
|
|
368
|
-
|
|
368
|
+
````ts
|
|
369
369
|
export interface BoardProps extends Omit<
|
|
370
370
|
SubcircuitGroupProps,
|
|
371
|
-
"subcircuit" | "connections"
|
|
371
|
+
"subcircuit" | "connections" | "outline"
|
|
372
372
|
> {
|
|
373
373
|
title?: string;
|
|
374
374
|
material?: "fr4" | "fr1" | "flex";
|
|
@@ -384,6 +384,18 @@ export interface BoardProps extends Omit<
|
|
|
384
384
|
boardAnchorPosition?: Point;
|
|
385
385
|
anchorAlignment?: z.infer<typeof ninePointAnchor>;
|
|
386
386
|
boardAnchorAlignment?: z.infer<typeof ninePointAnchor>;
|
|
387
|
+
/**
|
|
388
|
+
* Points defining the board edge. Set `isCastellatedHole` on a point to
|
|
389
|
+
* place a castellated plated hole centered on that location.
|
|
390
|
+
*
|
|
391
|
+
* @example
|
|
392
|
+
* ```tsx
|
|
393
|
+
* { x: "-5mm", y: 0, isCastellatedHole: true,
|
|
394
|
+
* holeDiameter: "0.8mm", padDiameter: "1.2mm",
|
|
395
|
+
* connectsTo: "net.GND" }
|
|
396
|
+
* ```
|
|
397
|
+
*/
|
|
398
|
+
outline?: BoardOutlinePoint[];
|
|
387
399
|
/** Color applied to both top and bottom solder masks */
|
|
388
400
|
solderMaskColor?: BoardColor;
|
|
389
401
|
/** Color of the top solder mask */
|
|
@@ -400,10 +412,15 @@ export interface BoardProps extends Omit<
|
|
|
400
412
|
doubleSidedAssembly?: boolean;
|
|
401
413
|
/** Whether vias may be placed inside PCB pads */
|
|
402
414
|
isViaInPadAllowed?: boolean;
|
|
415
|
+
/**
|
|
416
|
+
* Whether implicit copper pours should be generated automatically. Defaults
|
|
417
|
+
* to false.
|
|
418
|
+
*/
|
|
419
|
+
automaticPoursEnabled?: boolean;
|
|
403
420
|
/** Whether this board should be omitted from the schematic view */
|
|
404
421
|
schematicDisabled?: boolean;
|
|
405
422
|
}
|
|
406
|
-
|
|
423
|
+
````
|
|
407
424
|
|
|
408
425
|
[Source](https://github.com/tscircuit/props/blob/main/lib/components/board.ts)
|
|
409
426
|
|