Skip to content

Commit de2c725

Browse files
authored
feat: Add Document for Run frame JLCPCB Import (#292)
* feat: Doc for Runframe JLCPCB Import * Rename Runframe import to editor import * update layout
1 parent 48d2cf4 commit de2c725

File tree

5 files changed

+47
-24
lines changed

5 files changed

+47
-24
lines changed

docs/guides/importing-modules-and-chips/importing-from-jlcpcb.mdx

Lines changed: 47 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,54 @@ import YouTubeEmbed from '../../../src/components/YouTubeEmbed';
88

99
## Overview
1010

11-
JLCPCB has a massive component catalog of 3d models and footprints.
11+
JLCPCB maintains a massive component catalog with 3D models and footprints for thousands of parts. You can import these components directly into your tscircuit projects using several methods.
1212

13-
## Web Import
13+
## Import Using Editor Locally
14+
15+
The easiest way to import JLCPCB components is using the editor's built-in import dialog when running `tsci dev`. This provides a modern search interface with real-time stock information.
16+
17+
18+
<figure>
19+
<img src="/img/runframe-cli-setup.png" />
20+
<figcaption>Run `tsci dev` to start the development server</figcaption>
21+
</figure>
22+
23+
<figure>
24+
<img src="/img/runframe-import-dialog.png" />
25+
<figcaption>In the tsci dev environment, navigate to "File -> Import"</figcaption>
26+
</figure>
27+
28+
<figure>
29+
<img src="/img/runframe-jlcpcb-search.png" />
30+
<figcaption>Go to the JLCPCB Parts tab and search by part number (e.g., 'C5100227') or keyword (e.g., 'ESP32')</figcaption>
31+
</figure>
32+
33+
<figure>
34+
<img src="/img/runframe-jlcpcb-results.png" />
35+
<figcaption>Select component and click Import</figcaption>
36+
</figure>
37+
38+
<YouTubeEmbed youtubeId="tFCGAa81KUs" />
39+
40+
After importing, you can use the component in your circuit like this:
41+
42+
### Example Usage
43+
44+
```tsx
45+
import { ComponentName } from "@tsci/imported-component"
46+
47+
export default () => (
48+
<board width="10mm" height="10mm">
49+
<ComponentName />
50+
</board>
51+
)
52+
```
53+
54+
:::tip Tip
55+
Using File > Import from the editor locally is recommended
56+
:::
57+
58+
## Import Using Web UI
1459

1560
You can import JLCPCB components on [tscircuit.com](https://tscircuit.com). After
1661
importing the snippet, it'll be given a package name like `@tsci/YOUR_NAME.CHIP_NAME`
@@ -53,25 +98,3 @@ export default () => (
5398
</board>
5499
)
55100
```
56-
57-
58-
## CLI Import
59-
60-
To import JLCPCB components using the tsci dev environment, follow these steps:
61-
62-
1. Run `tsci dev` to start the development server
63-
2. In the tsci dev environment, navigate to "File -> Import"
64-
65-
<YouTubeEmbed youtubeId="tFCGAa81KUs" />
66-
67-
After importing, you can use the component in your circuit like this:
68-
69-
```tsx
70-
import { ComponentName } from "@tsci/imported-component"
71-
72-
export default () => (
73-
<board width="10mm" height="10mm">
74-
<ComponentName />
75-
</board>
76-
)
77-
```

static/img/runframe-cli-setup.png

493 KB
Loading
22.5 KB
Loading
66.8 KB
Loading
47.8 KB
Loading

0 commit comments

Comments
 (0)