🚀 Onionl-UI

A modern lightweight component library based on Vue 3.

English | 中文

⚠️ This project is still in its early stages of development.

🌱 This is my first open source project. As a beginner in open source, I'm learning and growing with this project. Any feedback and contributions are warmly welcomed!

📝 To-Do List

Check the TODO file to view the development plan of Onionl-UI. Suggestions, ideas or code contributions are welcome!

✨ Features

• 🎯 Built with Vue 3 + TypeScript, providing complete type definitions
• 🎨 Supports theme customization with configurable design tokens
• 📦 Supports on-demand importing to reduce bundle size
• 🔧 Rich collection of components and Hooks
• 📚 Comprehensive documentation and examples

🚀 Installation

Using npm:

# Install all required dependencies
npm install onionl-ui @onionl-ui/preset

Using yarn:

# Install all required dependencies
yarn add onionl-ui @onionl-ui/preset

Using pnpm:

# Install all required dependencies
pnpm add onionl-ui @onionl-ui/preset

🔨 Quick Start

import OnionlUI from 'onionl-ui'
import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)
app.use(OnionlUI)
app.mount('#app')

📦 Components

Basic usage:

<template>
  <ol-button type="primary">
    Primary Button
  </ol-button>
  <ol-button type="secondary">
    Secondary Button
  </ol-button>
  <ol-button size="lg">
    Large Button
  </ol-button>
</template>

For more component usage, please check the Component Documentation.

📄 License

MIT License © 2024 XL