Skip to content

Getting Started

Welcome to BreezeUI, a Vue 3 component library based on shadcn-vue.

Introduction

BreezeUI aims to provide lightweight, customizable, and easy-to-use components to help developers quickly build beautiful user interfaces. It is not just a component library, but a collection of reusable components based on Vue 3, Radix Vue, and Tailwind CSS.

Features

  • Lightweight: Small core library size, on-demand import.
  • Customizable: Based on Tailwind CSS, highly customizable styles.
  • Accessible: Based on Radix Vue, follows WAI-ARIA standards.
  • Type Safe: Written entirely in TypeScript.

Installation

To install and configure BreezeUI, please refer to the Installation Guide.

Why Choose BreezeUI?

If you are looking for a component solution that is easy to get started with and can meet complex business needs, BreezeUI is a good choice. It combines the flexibility of Tailwind CSS with the interactive capabilities of Radix Vue, allowing you to get a high-quality component experience without sacrificing customizability.

Next Steps

  • Read the Installation guide for a complete setup
  • Read the Theming guide for theme variables, dark mode and sizing
  • Start from Button to explore components