Skip to content

Getting Started

WARNING

This project is currently under active development and is not yet suitable for production use, as the APIs for all components are not yet stable.

Unify UI is a UI library for Vue.js 3.

  • Unify UI provides type definitions for all components because it was built with the latest stable version of TypeScript.
  • Unify UI supports tree shaking out of the box, as it was built using ES Modules.
  • While Unify UI does not have a direct dependency on Tailwind CSS, the styling of all components is heavily influenced by the style of Tailwind UI components.

Usage

  1. Install Unify UI
bash
pnpm add unify-ui
  1. Import css style in main js file
js
import "unify-ui/dist/style.css";
  1. Import components in your vue file
vue
<script setup lang="ts">
import { UniButton } from "unify-ui";
</script>

<template>
  <UniButton type="text">text button</UniButton>
</template>

Released under the MIT License.