GitHubX

Getting Started

PreviousNext

Start using Vuzeno

Prerequisites

Before installing Vuzeno components, make sure you have:

  • Vue 3.5+ — Vuzeno uses the latest Vue features
  • Tailwind CSS 4 — For styling components
  • shadcn-vue — Vuzeno extends shadcn-vue, so you'll need an existing setup

If you haven't set up shadcn-vue yet, follow their installation guide first.

Registry setup

Add Vuzeno to your components.json registries so you can install components with the @vuzeno/ shorthand:

      
      {
  "registries": {
    "@vuzeno": "https://vuzeno.com/r/{name}.json"
  }
}
    

Installation

Vuzeno is a shadcn-vue registry. Install components with the shadcn-vue CLI.

Requirements: Your project must already be set up with shadcn-vue (run bunx shadcn-vue@latest init if needed) and have a components.json file.

Add a Vuzeno component:

      
      bunx --bun shadcn-vue@latest add @vuzeno/[component]
    

Replace [component] with the component name: autocomplete, filters, image, image-viewer, gallery, phone-field, or time-field. Without registry setup, you can also install by URL: shadcn-vue add https://vuzeno.com/r/[component].json

The CLI will install the component and its registry dependencies (e.g. shadcn-vue Combobox, Input Group) into your project. Some components list extra npm dependencies on their docs (e.g. libphonenumber-js for Phone Field)—install those if prompted or as shown on the component page.

Manual installation

You can also copy component source code from the docs into your project. Each component page includes dependencies, source snippets, and usage examples.

TypeScript

Vuzeno is written in TypeScript and provides full type definitions. No additional configuration is required — types are inferred automatically.

Next Steps

Ready to add your first component? Check out:

  • Phone Field — A great starting point with auto-formatting and validation
  • Image — Enhanced images with zoom capabilities
  • Filters — Build complex filtering interfaces

Each component page includes detailed documentation, props reference, and usage examples.