boneyard README

The project's README from github.com/0xGF/boneyard. As one markdown file: README.md.

Boneyard

boneyard

Pixel-perfect skeleton loading screens, extracted from your real UI. No manual measurement, no hand-tuned placeholders.

Works with React, Preact, Vue, Svelte 5, Angular, and React Native.

Quick start

npm install boneyard-js

React

import { Skeleton } from 'boneyard-js/react'

function BlogPage() {
  const { data, isLoading } = useFetch('/api/post')
  return (
    <Skeleton name="blog-card" loading={isLoading}>
      {data && <BlogCard data={data} />}
    </Skeleton>
  )
}

With <Suspense> / useSuspenseQuery

Drop in <BoneSuspense> anywhere you'd use a <Suspense> boundary. The skeleton renders as the fallback at runtime, and the CLI captures bones from the resolved children at build time.

import { BoneSuspense } from 'boneyard-js/react'

function Page() {
  return (
    <BoneSuspense name="user-card">
      <UserCard />  {/* uses useSuspenseQuery */}
    </BoneSuspense>
  )
}

No initialData or placeholderData required — the build-time --wait window lets the query resolve naturally. Pass a fixture if the query can't finish in time.

Vue

<script setup>
import Skeleton from 'boneyard-js/vue'
import './bones/registry'
const loading = ref(true)
</script>

<template>
  <Skeleton name="card" :loading="loading">
    <Card />
  </Skeleton>
</template>

Svelte 5

<script>
  import Skeleton from 'boneyard-js/svelte'
  import '$lib/bones/registry'
  let loading = true
</script>

<Skeleton name="card" {loading}>
  <Card />
</Skeleton>

Preact

import { Skeleton } from 'boneyard-js/preact'

function BlogPage() {
  const { data, isLoading } = useFetch('/api/post')
  return (
    <Skeleton name="blog-card" loading={isLoading}>
      {data && <BlogCard data={data} />}
    </Skeleton>
  )
}

Angular

import { SkeletonComponent } from 'boneyard-js/angular'

@Component({
  imports: [SkeletonComponent],
  template: `
    <boneyard-skeleton name="card" [loading]="isLoading">
      <app-card />
    </boneyard-skeleton>
  `
})

React Native

import { Skeleton } from 'boneyard-js/native'

<Skeleton name="profile-card" loading={isLoading}>
  <ProfileCard />
</Skeleton>

npx boneyard-js build --native --out ./bones
# Open your app on device — bones capture automatically

Dynamic Type: Generate bones at default font scale. Boneyard automatically scales bone positions at runtime to match the user's text size setting.

Generate bones

# CLI — works with any framework
npx boneyard-js build

# Watch mode — re-captures on HMR changes
npx boneyard-js build --watch

# React Native — scans from device
npx boneyard-js build --native

Then import the registry once in your app entry:

import './bones/registry'

Vite plugin

For Vite-based projects (React, Preact, Vue, Svelte), use the plugin instead of the CLI — no second terminal needed:

// vite.config.ts
import { boneyardPlugin } from 'boneyard-js/vite'

export default defineConfig({
  plugins: [boneyardPlugin()]
})

Bones are captured automatically when the dev server starts and re-captured on every HMR update.

How it works

Web: The CLI (or Vite plugin) opens a headless browser, visits your app, finds every <Skeleton name="...">, and snapshots their layout at multiple breakpoints.

React Native: The <Skeleton> component auto-scans in dev mode when the CLI is running. It walks the fiber tree, measures views via UIManager, and sends bone data to the CLI. Zero overhead in production.

All frameworks output the same .bones.json format — cross-platform compatible.

CLI flags

Flag Default Description
[url] auto-detected URL to visit
--breakpoints 375,768,1280 Viewport widths, comma-separated
--wait 800 ms to wait after page load
--out ./src/bones Output directory
--force — Skip incremental cache
--watch — Re-capture on HMR changes
--native — React Native device scanning
--no-scan — Skip filesystem route scanning
--cdp — Connect to existing Chrome via debug port
--env-file — Load env vars from file

Props

Prop Type Default Description
loading boolean — Show skeleton or real content
name string — Unique name (generates name.bones.json)
color string rgba(0,0,0,0.08) Bone fill color
darkColor string rgba(255,255,255,0.06) Bone color in dark mode
animate 'pulse' | 'shimmer' | 'solid' 'pulse' Animation style
stagger number | boolean false Stagger delay between bones in ms (true = 80ms)
transition number | boolean false Fade out duration when loading ends (true = 300ms)
boneClass string — CSS class applied to each bone element
fixture ReactNode / Snippet / Slot — Mock content for CLI capture (dev only)
initialBones ResponsiveBones — Pass bones directly (overrides registry)
fallback ReactNode / Snippet / Slot — Shown when loading but no bones available

Config file

{
  "breakpoints": [375, 768, 1280],
  "out": "./src/bones",
  "wait": 800,
  "color": "#e5e5e5",
  "animate": "pulse"
}

Save as boneyard.config.json. Per-component props override config values.

Package exports

Import Use
boneyard-js snapshotBones, renderBones, computeLayout
boneyard-js/react React <Skeleton>
boneyard-js/preact Preact <Skeleton> (no compat needed)
boneyard-js/vue Vue <Skeleton>
boneyard-js/svelte Svelte <Skeleton>
boneyard-js/angular Angular <boneyard-skeleton>
boneyard-js/native React Native <Skeleton>
boneyard-js/vite Vite plugin boneyardPlugin()

Star History

Star History Chart

License

MIT

boneyard (0xGF/boneyard)

Searching Database…

7.5K ·GitHub
Boneyard
Что это такое?Boneyard генерирует скелеты загрузки с точностью до пикселя прямо из вашего реального интерфейса, и вам не нужно вручную рисовать заглушки.
Это библиотека или ещё и CLI-инструмент?Это JavaScript-библиотека (с точками входа для каждого фреймворка) плюс CLI/Vite-плагин, который собирает данные о разметке, рендеря ваше приложение в headless-браузере.
Как запустить это в моём приложении?Вставьте компонент туда, где вы обычно выводите границу загрузки, запустите CLI (или Vite-плагин для проектов на Vite), чтобы захватить bones, а затем один раз импортируйте сгенерированный реестр в точке входа приложения.
С какими фреймворками это работает?React, Preact, Vue, Svelte 5, Angular и React Native. У каждого есть отдельный экспорт пакета, например boneyard-js/react или boneyard-js/vue.
Чем захват bones отличается для React Native?Да. В вебе CLI снимает разметку через headless-браузер, а в React Native компонент автоматически сканирует себя в режиме разработки, обходя дерево fiber и измеряя view через UIManager. В продакшене в обоих случаях никаких накладных расходов нет.
Для кого это?Для фронтенд-разработчиков, которые создают приложения на React, Vue, Svelte, Angular или React Native и хотят получать точные скелеты загрузки без ручного измерения разметки.
Работает ли это с изменением размера текста на мобильных устройствах?Да. Для React Native bones генерируются при шрифте по умолчанию, а позиции костей автоматически масштабируются во время работы, чтобы соответствовать настройке размера текста пользователя (Dynamic Type).
Какие стили анимации доступны для костей?Bones поддерживают три стиля анимации через проп animate: pulse (по умолчанию), shimmer и solid, а также необязательные задержки stagger и плавное затухание при переходе (fade-out).
Могу ли я передать моковые данные, если реальный запрос не успевает загрузиться во время захвата?Да, передайте проп fixture с моковыми данными, чтобы CLI было что измерить на этапе сборки, если реальные данные не успевают загрузиться достаточно быстро.
Перезахватываются ли bones автоматически во время разработки?С Vite-плагином bones захватываются при запуске dev-сервера и автоматически перезахватываются при каждом обновлении HMR. У CLI для того же есть флаг --watch.
What are similar projects?loadersz-core, storybook, blobatar, shaders, ng-native, pragmatic-drag-and-drop, mitosis, openreplay
Which topics is it in?svelte, angular, react-native, vite, javascript-library, vue, animation, ios, android, react, npm, frontend
Creator
0xGF
Size
1.2 MB
Stars
7.5K
Updated
CommitAug 31Releasev1.10.0Aug 31
Age
6mo
Commits · 90 Days