# vuetom-ui

**Repository Path**: lauset/vuetom-ui

## Basic Information

- **Project Name**: vuetom-ui
- **Description**: 支持 Vue3 的扁平化 UI。可以将其作为一个UI模版，加入个人自定义的组件让其成为个人的一个简单UI库
- **Primary Language**: HTML
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: http://212.64.67.168:8084
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2021-10-18
- **Last Updated**: 2024-04-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Vue, TypeScript, UI

## README

<p align="center"></p>

<p align="center">
   <a href="https://github.com/lauset/vuetom-ui" target="_blank">
      <img src="docs/public/logo/vuetom-logo.png" alt="vuetom-logo" width="60px" height="auto">
   </a>
</p>

<h1 align="center">
   <a href="https://github.com/lauset/vuetom-ui" target="_blank" align="center">
      Vuetom UI - A Vue3 UI library
   </a>
</h1>

<p align="center">
   <a href="https://github.com/themeselection/materio-vuetify-vuejs-admin-template-free/blob/main/LICENSE">
      <img src="https://img.shields.io/github/license/themeselection/materio-vuetify-vuejs-admin-template-free" alt="license">
   </a>
   <a href="https://www.npmjs.com/package/vitepress-theme-vuetom">
   <img alt="npm" src="https://img.shields.io/npm/v/vuetom-ui"></a>
</p>


## Introduction 📜

A Vue3 UI library

<!-- [View document]() -->

## Quick Start 🏷️

**install**

   ```
   npm i vuetom-ui
   ```

**use(es)**

   ```
   import VuetomUI from 'vuetom-ui'
   import 'vuetom-ui/dist/vuetom-ui.css'
   ```

**use(borwser)**

   ```html
   <script src="https://unpkg.com/vue@next"></script>
   <script src="../dist/vuetom-ui.js"></script>
   <link rel="stylesheet" href="../dist/vuetom-ui.css">

   const app = Vue.createApp(App);
   app.use(VuetomUI);
   app.mount("#app");
   ```

## development ⚒

1. Install all packages

   ```bash
   npm i 

   # npm install [for npm]
   ```

2. Generate build files for deployment

   ```bash
   npm run build

   # npm run b [for development build]
   # npm run build:umd [for umd]
   # npm run build:esm [for es]
   # npm run build:theme [for themes]
   ```

3. Run document server

   ```bash
   npm run docs
   ```

## What's Included 📦

- dist
- docs
- src
  - components 
  - utils
  - index.ts
- test
- types

## What's in New Version 💎

| VuetomUI Version | Info |
| - | :- |
0.1.0 | Button Row Col |
0.2.0 | Table Message |

## UI Support 🖥️

- ~~Nodj.js (require)~~
- ES6 (import)
- Browser (`<script>`)

## Changelog 📆

Please refer to the [ChangeLog](CHANGELOG.md) file.

## Credits 🙏

- [Vue3](https://staging-cn.vuejs.org/)
- [Vuetify](https://vuetifyjs.com/)
- [ElementPlus](https://element-plus.gitee.io/zh-CN/)
- [Iconfont](https://www.iconfont.cn/)


## Useful Links 🔗

- [Gitee](https://gitee.com/lauset/vuetom-ui)
- [Github](https://github.com/lauset/vuetom-ui)


## Social Media 🌍
- [Blog](http://blog.tomhub.com)