Skip to main content
You are viewing Pre-Alpha documentation.
Vuetify0 Logo

Using the Docs

Edit this page
Report a Bug
Copy Page as Markdown

This guide helps you get the most out of v0 documentation. Whether you’re exploring headless components for the first time or diving deep into composable architecture, these features will accelerate your learning.

Key features:

  • Ask AI — Context-aware assistant that knows every page
  • Skill filtering — Show content matching your experience level
  • Interactive examples — Live demos with editable code
  • Keyboard-first — Navigate entirely without a mouse

Documentation Structure

The docs are organized into distinct sections, each serving a specific purpose:

SectionPurposeWhen to use
GuideConceptual learningUnderstanding architecture, patterns, best practices
ComponentsHeadless UI primitivesBuilding accessible interfaces (Dialog, Popover, Selection)
ComposablesLogic building blocksAdding behavior without UI (createContext, createSelection)
APIComplete referenceLooking up props, events, slots, methods
StorybookVisual playgroundExploring component variants interactively

Each component and composable page follows a consistent structure: overview, usage examples, anatomy, and API reference.

Skill Levels & Learning Tracks

Use the filter to show only pages matching your experience level:

Skill Levels

Every page is tagged with a skill level to help you find content appropriate for your experience:

LevelBadgeFor
1BeginnerNew to v0, learning fundamentals
2IntermediateBuilding with components, practical usage
3AdvancedArchitecture deep-dives, custom patterns

Learning Tracks

The Guide overview defines three learning tracks for structured progression:

Track A: Core Concepts — Understanding the system

  1. Structure — Package organization and imports
  2. Core — Trinity, Context, and Registry patterns
  3. Components — Headless primitives and slot props
  4. Plugins — Vue plugin integration

Track B: Features & Polish — Production-ready UIs

  1. Theming — CSS variables and design tokens
  2. Accessibility — ARIA patterns and keyboard navigation
  3. Utilities — Helper functions and type guards

Track C: Real-World Application — See v0 in production

  1. Building Docs — How this documentation site uses v0

New to v0? Start with Track A. Already building? Jump to Track B as needed.

Table of Contents

The right sidebar (desktop only) shows an outline of the current page:

  • Auto-generated from H2, H3, and H4 headings
  • Scroll spy: Highlights your current section as you read
  • Click any heading to jump directly to that section

At the bottom of each page, you’ll find links to related content. These cross-references help you discover connected concepts and navigate between related components and composables.

Explore these related pages for additional context and usage patterns.

PageCategory
AI ToolsGuide
Getting StartedIntroduction

Previous / Next

Footer navigation at the bottom of each page links to adjacent pages in the current section, allowing linear reading through the documentation.



  • Click the search button in the header (“Search the docs…”)
  • Press Ctrl+K (Windows/Linux) or Cmd+K (Mac)

The search system uses fuzzy matching, so typos and partial words still find results:

  • "creat contxt" finds createContext
  • "dialg" finds Dialog
  • "selec" finds Selection, createSelection

Results are grouped by category, with Guide pages prioritized. Maximum 20 results are shown per query.

Keyboard Navigation

KeyAction
/ Navigate through results
EnterGo to selected result
EscapeClose search
Tip

Search indexes page titles, headings, and content. For API lookups, try searching the exact function or component name.

Ask AI

The documentation includes a context-aware AI assistant that understands v0 concepts and has access to the current page’s content.

Opening Ask AI

  • Click the floating input at the bottom of any page
  • Press Ctrl+/ (Windows/Linux) or Cmd+/ (Mac)

On desktop, the chat opens as a right-side panel. On mobile, it opens as a full-screen modal.

What the AI Knows

The AI has access to the entire v0 documentation via llms-full.txt, but prioritizes the current page for more relevant answers:

ContextDescription
Full docsComplete documentation available for cross-referencing
ExamplesLive Vue code from the page’s interactive demos
API specsProps, events, slots, and methods for the current component/composable
BenchmarksPerformance metrics (for composables)
HistoryYour last 6 messages in the conversation

This context makes answers specific and actionable. Asking “How do I open this programmatically?” on the Dialog page gives you Dialog-specific code.

SUGGESTION Callouts

Throughout the documentation, you’ll find clickable “Ask AI” boxes:

Ask AI
How do I add styling or CSS classes to headless components?

These are pre-written questions relevant to the current topic. Click one to instantly send it to Ask AI.

Chat Features

  • Streaming: Responses appear in real-time as they’re generated
  • Markdown: Responses include formatted code with syntax highlighting
  • Diagrams: Mermaid diagrams render inline when relevant
  • Copy: Copy the entire conversation to clipboard
  • Bin: Save to Vuetify Bin for sharing
  • Stop: Cancel generation mid-stream if needed

The AI can generate syntax-highlighted code blocks and Mermaid diagrams directly in responses. Ask for architecture diagrams, data flow visualizations, or working code examples.

Tip

Ask AI works best on component and composable pages where it has access to examples and API data. For general questions, try the Guide pages.

Example Prompts

Click any suggestion to send it to Ask AI:

  • Ask AI
    Show me how to use Dialog with v-model
  • Ask AI
    What's the difference between createSelection and createGroup?
  • Ask AI
    Explain the slot props for Step.Item

Or type your own question:


Interactive Examples

Most component and composable pages include live, interactive examples.

Live Previews

Examples render as functional components you can interact with directly:

  • Click buttons, open dialogs, select items
  • See real behavior without leaving the docs
  • Examples use the same code shown below them
Interactive Group Example

Selected: apple, banana

Code Toggle

Click “Show code” to reveal the source code for any example:

  • Syntax highlighted with proper Vue/TypeScript coloring
  • Click “Hide code” to collapse

Actions

Hover over the code block to reveal action buttons:

Example.vue
<script setup lang="ts">
  import { shallowRef } from 'vue'

  const count = shallowRef(0)
</script>

<template>
  <button @click="count++">Count: {{ count }}</button>
</template>
ButtonAction
PlayOpen in Vuetify Play with full editing environment
BinOpen in Vuetify Bin for sharing
WrapToggle line wrapping for long lines
CopyCopy code to clipboard (checkmark confirms success)

Code Groups

Some examples show multiple variants in tabbed code blocks:

  • Click tabs to switch between versions
  • Use / arrow keys when focused
  • Tab state is independent per code group

Diagrams

Architecture and flow diagrams use Mermaid. Click any diagram to open an expanded view in a dialog.

Horizontal flow for pipelines and transformations:

Horizontal Flow

Click outside or press Escape to close

Horizontal Flow

Vertical flow for hierarchies and dependencies:

Vertical Flow

Click outside or press Escape to close

Vertical Flow

Subgraphs group related concepts (from useProxyModel):

Subgraph Example

Click outside or press Escape to close

Subgraph Example

API Reference

Every component and composable includes comprehensive API documentation.

Inline API

By default, API tables appear directly on the page in expandable sections:

  • Props: Input properties with types, defaults, and descriptions
  • Events: Emitted events with payload types
  • Slots: Template slots with scope props
  • Options: Configuration options (composables)
  • Methods: Exposed functions (composables)
  • Properties: Reactive properties (composables)

Click any item to expand its details, including code examples where available.

Dedicated API Pages

For focused reference, visit /api/{name}:

  • All component variants shown together (e.g., Dialog.Root, Dialog.Content)
  • Full details without page navigation
  • Useful for side-by-side comparison

Toggle between views using “View standalone ↓” / “Show inline →” in the API section header.

API Hover

In code examples throughout the docs, component and composable names are interactive. Hover over any recognized name to see a quick reference popover:

vue
<script setup lang="ts">
  import { Step } from '@vuetify/v0'
  import { shallowRef } from 'vue'

  const current = shallowRef('step1')
</script>

<template>
  <Step.Root v-model="current">
    <Step.Item value="step1">Step 1</Step.Item>
    <Step.Item value="step2">Step 2</Step.Item>
  </Step.Root>
</template>
ts
import { useTheme } from '@vuetify/v0'

const theme = useTheme()

theme.isDark.value // boolean
theme.toggle() // switch themes
  • Hover over Step.Root, Step.Item, or useTheme above to see the popover
  • Shows description and key API members
  • Click “View API →” to jump to the full reference
Tip

The hover works on any recognized v0 component or composable in code blocks, making it easy to explore without leaving your current page.

Callouts

The documentation uses callout boxes to highlight important information:

Tip

Best practices and helpful hints you can apply immediately.

Info

Additional context and notes for deeper understanding.

Warning

Cautions and common mistakes to avoid.

Ask AI
What's the difference between createSelection and createGroup?

Keyboard Shortcuts

Navigate the entire documentation without touching a mouse:

ShortcutAction
Ctrl/Cmd + KOpen search
Ctrl/Cmd + /Open/focus Ask AI
EscapeClose search or Ask AI
/ Navigate search results
EnterSelect search result
/ Navigate code group tabs
TabMove focus forward
Shift + TabMove focus backward

All keyboard shortcuts work with both Ctrl (Windows/Linux) and Cmd (Mac).

Settings

Click the settings button in the header to open the settings panel:

The settings panel provides personalization options that persist across sessions.

Theme

Choose your preferred color scheme:

Theme

Skill Level

Filter documentation pages by complexity. Selected levels appear in the navigation—pages outside your selection are hidden.

Skill Level

Filter documentation by complexity level

Code Examples

Toggle line wrapping for long lines in code blocks:

Code Examples

Motion

Control animations: follow your OS preference, force reduce, or enable full motion.

Motion

Reduce or disable animations

Package Manager

Set your default for installation code examples:

Package Manager

Default for code examples

Header Buttons

Toggle visibility of header controls to reduce clutter:

Header Buttons

Show or hide buttons in the header

Accessibility

The documentation is built with accessibility in mind:

  • Full keyboard navigation — Every interactive element is reachable via keyboard
  • ARIA labels — Screen readers announce all controls correctly
  • Skip link — “Skip to main content” link appears on focus
  • Reduced motion — Animations respect prefers-reduced-motion
  • Focus indicators — Clear visual focus states throughout
  • Semantic HTML — Proper heading hierarchy and landmarks

Community & Contributing

Contribute

Found an error or want to improve the docs? Contributions are welcome:

  • Each page links to its source on GitHub
  • Submit pull requests for fixes or enhancements
  • See the Contributing Guide for details
Tip

The easiest way to contribute is to click “Edit this page” near the top of any documentation page.


© 2016-2026 Vuetify, LLC
Ctrl+/