docs/README.md

Back to demo

npm version npm downloads license

auto-skeleton-react Documentation

Comprehensive documentation for the auto-skeleton-react package.

Table of Contents

  1. Getting Started - Installation, basic usage, and your first skeleton
  2. How It Works - The rendering pipeline and architecture overview
  3. API Reference - Component props, types, and default values
  4. Configuration - All configuration options explained with examples
  5. Opt-Out (No Skeleton) - Keep specific elements visible during loading
  6. Table Support - HTML table structure preservation
  7. Escape Hatches - Force skeleton types with data attributes
  8. Examples - Real-world usage patterns and code snippets
  9. Architecture Deep Dive - Internals: scoring, multi-line text, rendering
  10. FAQ & Troubleshooting - Common questions and known limitations

Quick Links