@zuoyo/viteui 0.0.2 → 0.0.3

package/README_EN.md

@@ -0,0 +1,227 @@
+# ViteUI Documentation
+
+[简体中文](./README.md) | **English**
+
+---
+
+## Introduction
+
+ViteUI is a modern UI component library based on Vue 3 and TypeScript, providing rich enterprise-level components to help you quickly build beautiful and efficient web applications.
+
+### Features
+
+- 🚀 Built on Vue 3 Composition API
+- 💪 Written in TypeScript with complete type definitions
+- 📦 50+ high-quality components out of the box
+- 🎨 Theme customization support
+- 🌍 Internationalization support
+- ⚡️ Built with Vite for excellent development experience
+
+## Getting Started
+
+### Requirements
+
+- Node.js >= 14.0.0
+- Vue >= 3.2.0
+
+### Installation
+
+#### Using npm
+
+```bash
+npm install viteui --save
+```
+
+#### Using pnpm
+
+```bash
+pnpm add viteui
+```
+
+#### Using yarn
+
+```bash
+yarn add viteui
+```
+
+### Full Import
+
+Import in `main.ts`:
+
+```typescript
+import { createApp } from 'vue';
+import App from './App.vue';
+import ViteUI from 'viteui';
+import 'viteui/dist/themes/default/index.css';
+import 'viteui/dist/themes/icon.css';
+
+const app = createApp(App);
+app.use(ViteUI);
+app.mount('#app');
+```
+
+### On-demand Import
+
+```typescript
+import { createApp } from 'vue';
+import App from './App.vue';
+import { VuLinkButton, VuPanel, VuDataGrid } from 'viteui';
+import 'viteui/dist/themes/default/index.css';
+import 'viteui/dist/themes/icon.css';
+
+const app = createApp(App);
+app.component(VuLinkButton.name, VuLinkButton);
+app.component(VuPanel.name, VuPanel);
+app.component(VuDataGrid.name, VuDataGrid);
+app.mount('#app');
+```
+
+### Usage
+
+Use in components:
+
+```vue
+<template>
+  <vu-link-button @click="handleClick">Click Me</vu-link-button>
+</template>
+
+<script setup lang="ts">
+const handleClick = () => {
+  console.log('Button clicked!');
+};
+</script>
+```
+
+## Theme Customization
+
+ViteUI provides multiple built-in themes for you to choose from:
+
+### Available Themes
+
+- `default` - Default theme
+- `bootstrap` - Bootstrap style
+- `black` - Black theme
+- `gray` - Gray theme
+- `metro` - Metro style
+- `material` - Material Design style
+- `material-blue` - Material Design Blue
+- `material-teal` - Material Design Teal
+
+### Using Themes
+
+```typescript
+// Import theme styles
+import 'viteui/dist/themes/material/index.css';
+import 'viteui/dist/themes/icon.css';
+```
+
+## Internationalization
+
+ViteUI supports multiple languages with 30+ built-in language packs.
+
+### Usage
+
+```typescript
+import { createApp } from 'vue';
+import ViteUI from 'viteui';
+import enUS from 'viteui/dist/locale/lang-en';
+
+const app = createApp(App);
+app.use(ViteUI, {
+  locale: enUS
+});
+```
+
+### Supported Languages
+
+- zh_CN - Simplified Chinese
+- zh_TW - Traditional Chinese
+- en - English
+- ja - Japanese
+- ko - Korean
+- fr - French
+- de - German
+- es - Spanish
+- And more...
+
+## Form Validation
+
+ViteUI provides powerful form validation features.
+
+### Built-in Validation Rules
+
+```typescript
+import { ValidateRules } from 'viteui';
+
+// Add custom validation rule
+ValidateRules.customRule = {
+  validator: (value: any) => {
+    return value.length >= 6;
+  },
+  message: 'Length must be greater than or equal to 6'
+};
+```
+
+### Using in Forms
+
+```vue
+<vu-form :model="formData" :rules="rules" ref="formRef">
+  <vu-form-field name="username" label="Username">
+    <vu-text-box v-model="formData.username"></vu-text-box>
+  </vu-form-field>
+</vu-form>
+```
+
+## Global Configuration
+
+### Configuration Options
+
+```typescript
+app.use(ViteUI, {
+  locale: enUS,           // Locale configuration
+  rules: {                // Custom validation rules
+    customRule: {
+      validator: (value) => value.length >= 6,
+      message: 'Length must be greater than or equal to 6'
+    }
+  }
+});
+```
+
+## FAQ
+
+### 1. Styles not working?
+
+Make sure you have imported the style files correctly:
+
+```typescript
+import 'viteui/dist/themes/default/index.css';
+import 'viteui/dist/themes/icon.css';
+```
+
+### 2. Incomplete TypeScript type hints?
+
+Make sure you have configured the types correctly in `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "types": ["viteui"]
+  }
+}
+```
+
+## Browser Support
+
+- Chrome >= 90
+- Firefox >= 88
+- Safari >= 14
+- Edge >= 90
+
+## Contact Us
+
+- Official Website: https://www.viteui.com
+
+---
+
+**Thank you for using ViteUI!** 🎉

package/package.json

@@ -1,19 +1,36 @@
 {
   "name": "@zuoyo/viteui",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.0.3",
+  "description": "A modern UI component library for Vue 3",
+  "keywords": [
+    "vue",
+    "vue3",
+    "vite",
+    "ui",
+    "components",
+    "typescript"
+  ],
+  "author": "zuoyo",
+  "license": "MIT",
   "type": "module",
   "scripts": {
     "dev": "vite",
     "build": "vite build && tsc -p tsconfig.build.json",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "prepublishOnly": "npm run build"
   },
-  "dependencies": {
-    "core-js": "^3.30.0",
-    "vite-plugin-static-copy": "^3.1.4",
-    "vue": "^3.2.47"
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "peerDependencies": {
+    "vue": "^3.2.0"
   },
+  "dependencies": {},
   "devDependencies": {
+    "vue": "^3.2.47",
+    "vite-plugin-static-copy": "^3.1.4",
     "@types/node": "^20.0.0",
     "@vitejs/plugin-vue": "^4.1.0",
     "@vitejs/plugin-vue-jsx": "^3.0.0",
@@ -34,6 +51,8 @@
     "./dist/locale/*": "./dist/locale/*"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "README_EN.md"
   ]
 }