Skip to content

docs: add local STEP model import example for cadmodel #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
techmannih2 wants to merge 3 commits into
base: main
Choose a base branch
from
+27,382 −0
Open

docs: add local STEP model import example for cadmodel #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4112432
docs: add local STEP model import example for cadmodel
techmannih2 Apr 28, 2026
5d1ad24
up
techmannih2 May 1, 2026
2faada5
Merge branch 'tscircuit:main' into ka
techmannih2 May 7, 2026
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
30 changes: 30 additions & 0 deletions docs/elements/cadmodel.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,36 @@ export default () => (
}}
/>

## Importing local STEP models

You can import a local `.step` file the same way as any other static model asset,
then pass the imported URL to `modelUrl`.

<CircuitPreview
splitView
defaultView='3d'
hidePCBTab
hideSchematicTab
browser3dView={false}
mainComponentPath='index.tsx'
fsMap={{
"index.tsx": `
import soic8StepUrl from "./models/soic8.step"

export default () => (
<board>
<chip
name="U1"
footprint="soic8"
cadModel={<cadmodel modelUrl={soic8StepUrl} />}
/>
</board>
)
`,
"./models/soic8.step": `__STATIC_ASSET__`
}}
/>

## Providing a STEP model

You can provide a STEP model to the `<cadmodel />` element by setting the `modelUrl`.
Expand Down
Loading
Loading