API Reference

Everything you can pass to <Skeleton> and the build CLI.

<Skeleton> props

loading boolean required

When true, shows the skeleton. When false, shows your real content.

children Snippet required

Your actual component. This is what boneyard reads to figure out where to put the skeleton rectangles.

name string required

A unique name for this skeleton. The build CLI uses this to create the .bones.json file.
Example: name="blog-card" → generates blog-card.bones.json

bones SkeletonResult | ResponsiveBones

Optional manual override — pass a bones JSON file directly to a specific Skeleton. If you use the registry, you don't need this prop.

color string default: rgba(0,0,0,0.08)

The color of the skeleton rectangles in light mode.

darkColor string default: rgba(255,255,255,0.06)

The color of the skeleton rectangles in dark mode.

animate boolean default: true

The pulse animation. Set to false if you want static gray rectangles with no animation.

class string

An extra CSS class on the wrapper div.

fallback Snippet

What to show if you haven't generated bones yet.

fixture Snippet

Mock content rendered during bun boneyard-svelte build so the CLI can capture bone positions even when real data isn't available.

snapshotConfig SnapshotConfig

Controls how the build CLI extracts bones.