Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/footprints/courtyardcircle.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: <courtyardcircle />
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"

<CircuitPreview defaultView="pcb" hideSchematicTab hide3DTab code={`
export default () => (
<board width="20mm" height="20mm">
<courtyardcircle radius={2} />
<courtyardcircle radius={2} pcbX={5} />
</board>
)
`} />

## Props

| Prop | Type | Description |
| :--- | :--- | :--- |
| `radius` | `number \| string` | The radius of the circle. |
| ...`PcbLayoutProps` | | Inherited PcbLayoutProps (e.g. `pcbX`, `pcbY`, `layer`, `pcbRotation`). |
45 changes: 45 additions & 0 deletions docs/footprints/courtyardoutline.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: <courtyardoutline />
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"

<CircuitPreview defaultView="pcb" hideSchematicTab hide3DTab code={`
export default () => (
<board width="20mm" height="20mm">
{/* Triangle shape */}
<courtyardoutline
outline={[
{ x: 0, y: 0 },
{ x: 3, y: 0 },
{ x: 1.5, y: 2.5 },
]}
/>
{/* L-shaped polygon on bottom layer */}
<courtyardoutline
outline={[
{ x: 5, y: 0 },
{ x: 8, y: 0 },
{ x: 8, y: 1 },
{ x: 6, y: 1 },
{ x: 6, y: 3 },
{ x: 5, y: 3 },
]}
layer="bottom"
/>
</board>
)
`} />

## 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`). |
27 changes: 27 additions & 0 deletions docs/footprints/courtyardrect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: <courtyardrect />
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"

<CircuitPreview defaultView="pcb" hideSchematicTab hide3DTab code={`
export default () => (
<board width="20mm" height="20mm">
<courtyardrect width={2} height={3} />
<courtyardrect width={4} height={1} pcbX={5} layer="bottom" />
</board>
)
`} />

## 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`). |
Loading