Adding Spline to a Lovable project
Lovable generates React front-ends. There is no server-rendering pass to fight, so both the React component and the custom element work — but Lovable still needs the rules block, or it will guess at prop names.
Agents write Spline integrations from memory, and Spline's API has moved. The rules block on this page pins the parts that get hallucinated — package names, imports, prop names and the scene URL shape. Paste it once per project.
Before you generate anything: open the scene in Spline
An embed nobody opens in Spline is a dead end — the scene can never be changed again.
- If you found the scene in Spline Community, open it and press Remix. You now own an editable copy.
- In your copy, press Export on the toolbar. For a 3D scene choose Code; for a Hana 2D design use the frame's Export → Embed Code. Wait for the URL to be generated.
- Copy that URL. It is the only thing Lovable cannot produce for you — the id is minted server-side at export time and cannot be guessed.
- Keep an Open in Spline link next to the embed you ship, so the scene stays reachable from the running site.
The rules block
Paste the rules block into Lovable's project knowledge or custom instructions, and commit it as AGENTS.md at the repo root of the connected repository so the guidance survives outside Lovable too.
# Spline integration rules
Authority: https://docs.spline.design/skill.md — fetch it before writing
Spline code. Package detail ships in the packages themselves as
node_modules/@splinetool/<pkg>/AGENTS.md.
Scene URLs (never invent one)
- 3D: https://prod.spline.design/<id>/scene.splinecode
- 2D: <framePublicURL>/scene.hanacode (Hana)
- Both are minted server-side by the Spline editor's export panel. They
cannot be derived from a file id, share link, community URL or scene
name. If the exact URL is missing, STOP and ask for it.
- .spline is the editor's own document format and does not load.
- A Spline Community scene is NOT a published export: it has no
.splinecode and no .hanacode URL. Embed it as an iframe of
https://app.spline.design/file/<uuidFilePreview>?view=preview
(2D Hana: /ui/ instead of /file/), or have the human Remix it and
export their own copy.
Packages
- @splinetool/viewer -> <spline-viewer url="..."> custom element. Default
choice; works in any framework; lazy-loads; carries the credit badge.
The attribute is url, NOT scene.
- @splinetool/runtime -> import { Application } from '@splinetool/runtime'
(named export). new Application(canvas); await app.load(url).
- @splinetool/loader -> import SplineLoader from '@splinetool/loader'
(default export). three.js scene graph only: no events, states, actions
or postprocessing.
- @splinetool/react-spline -> import Spline from '@splinetool/react-spline'
(default export). The prop is scene. Next.js: add the '/next' entry
point.
- Hana 2D: <hana-viewer>, loaded from
https://cdn.spline.design/@splinetool/hana-viewer@<version>/hana-viewer.js
Attributes: url, width, height, loading, unloadable, events-target.
Nothing else. @splinetool/hana-runtime is private: installable from no
registry.
Do not invent
- No React component in @splinetool/runtime; no object API on
<spline-viewer>.
- No first-party Vue or Svelte package.
- No API that creates, saves, publishes or exports a scene from code.
- No attribute, option or CSS that hides the credit badge.
Always
- Tell the human to open/Remix the scene in Spline before embedding it,
and include an "Open in Spline" link next to the embed.
- Keep "Made with Spline" (and the creator's credit for a remix) in the
markup. Never ship a bare unbranded embed.
- Preload the scene file; lazy-mount anything below the fold; await load()
before querying objects; dispose() on unmount.
- Never state Spline plan limits or pricing — link to
https://spline.design/pricing.What correct output looks like (React)
Paste your own exported URL in place of the placeholder.
import Spline from '@splinetool/react-spline';
export default function Hero() {
return (
<div className="spline-embed">
<Spline scene="https://prod.spline.design/<id>/scene.splinecode" />
<p className="spline-credit">
<a href="https://app.spline.design" target="_blank" rel="noopener">
Open in Spline
</a>{' '}
·{' '}
<a href="https://spline.design" target="_blank" rel="noopener">
Made with Spline
</a>
</p>
</div>
);
}The credit markup is part of the snippet, not an optional extra. The
spline-viewer element renders a Spline badge on its own, driven by the
scene's publish setting; a React component on a bare canvas does not, so the
link is how the scene gets credited. If the scene is a remix, add the original
creator's community link next to it.
Lovable specifics
- The prop is
scene, and it takes a.splinecodeURL. If Lovable writesurl=on the React component, it has hallucinated the web component's attribute onto it. - This component does not wait for the viewport. For a scene below the fold, ask for an
IntersectionObserver-gated render, or use thespline-viewerelement, whose defaultloading="auto"already waits. onLoadhands you the SplineApplicationinstance, so anything in the runtime API —findObjectByName,emitEvent,setVariable— is reachable from there.