Your Product
  • Funktionen
  • Preise
  • FAQ
  • Doku
Loslegen
Your Product
  • Introduction
  • Components Example

Search documentation

Search example documentation pages.

Documentation/Components Example

Components Example

Show reusable component documentation with props, states, and usage notes.

Component Purpose

Describe what the component does, where it appears, and when customers should use it.

Keep component docs focused on decisions customers actually need to make.

Usage Example

A focused code sample is usually enough for a starter kit component page.

Pair the snippet with short text that names the expected props and behavior.

typescript
type EmptyStateProps = {
  title: string
  description: string
}

export function EmptyState({ title, description }: EmptyStateProps) {
  return (
    <div className="rounded-lg border border-border p-6">
      <h2 className="font-semibold">{title}</h2>
      <p className="mt-2 text-sm text-foreground/80">{description}</p>
    </div>
  )
}

States

Document empty, loading, success, and error states when they change how customers should implement the component.

This also gives buyers a repeatable template for documenting their own product components.

Ship Example

Provide a release oriented example page for deployment and handoff notes.

On this page
Component PurposeUsage ExampleStates