diff --git a/docs/footprints/courtyardcircle.mdx b/docs/footprints/courtyardcircle.mdx new file mode 100644 index 00000000..ddab611f --- /dev/null +++ b/docs/footprints/courtyardcircle.mdx @@ -0,0 +1,26 @@ +--- +title: +description: Courtyard circles are used to define the physical boundary of a component. +--- + +## Overview + +Courtyard circles define the physical boundary of a circular component or feature, including potential tolerance. + +import CircuitPreview from "@site/src/components/CircuitPreview" + + ( + + + + + ) +`} /> + +## Props + +| Prop | Type | Description | +| :--- | :--- | :--- | +| `radius` | `number \| string` | The radius of the circle. | +| ...`PcbLayoutProps` | | Inherited PcbLayoutProps (e.g. `pcbX`, `pcbY`, `layer`, `pcbRotation`). | diff --git a/docs/footprints/courtyardoutline.mdx b/docs/footprints/courtyardoutline.mdx new file mode 100644 index 00000000..b43d7b4a --- /dev/null +++ b/docs/footprints/courtyardoutline.mdx @@ -0,0 +1,45 @@ +--- +title: +description: Courtyard outlines are used to define the physical boundary of a component with a custom shape. +--- + +## Overview + +Courtyard outlines define the physical boundary of a component using a custom shape defined by a series of points. + +import CircuitPreview from "@site/src/components/CircuitPreview" + + ( + + {/* Triangle shape */} + + {/* L-shaped polygon on bottom layer */} + + + ) +`} /> + +## Props + +| Prop | Type | Description | +| :--- | :--- | :--- | +| `outline` | `Point[]` | An array of points defining the vertices of the polygon. | +| `close` | `boolean` | Whether the outline should be closed. Defaults to `true` (implicit). | +| ...`PcbLayoutProps` | | Inherited PcbLayoutProps (e.g. `pcbX`, `pcbY`, `layer`, `pcbRotation`). | diff --git a/docs/footprints/courtyardrect.mdx b/docs/footprints/courtyardrect.mdx new file mode 100644 index 00000000..627c6c2e --- /dev/null +++ b/docs/footprints/courtyardrect.mdx @@ -0,0 +1,27 @@ +--- +title: +description: Courtyard rectangles are used to define the physical boundary of a component. +--- + +## Overview + +Courtyard rectangles define the physical boundary of a component, including potential tolerance. They are critical for ensuring components are not placed too close together. + +import CircuitPreview from "@site/src/components/CircuitPreview" + + ( + + + + + ) +`} /> + +## Props + +| Prop | Type | Description | +| :--- | :--- | :--- | +| `width` | `number \| string` | The width of the rectangle. | +| `height` | `number \| string` | The height of the rectangle. | +| ...`PcbLayoutProps` | | Inherited PcbLayoutProps (e.g. `pcbX`, `pcbY`, `layer`, `pcbRotation`). |