quail-ui 0.0.10 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +37 -11
  2. package/dist/index.js +174 -174
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.umd.cjs +1 -1
  5. package/dist/index.umd.cjs.map +1 -1
  6. package/package.json +2 -1
package/README.md CHANGED
@@ -1,18 +1,44 @@
1
- # Vue 3 + TypeScript + Vite
1
+ # Quail UI
2
2
 
3
- This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
3
+ The Vue3 UI library for [Quail](https://quail.ink).
4
4
 
5
- ## Recommended IDE Setup
5
+ ## Installation
6
6
 
7
- - [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
7
+ ```bash
8
+ npm install quail-ui
9
+ ```
8
10
 
9
- ## Type Support For `.vue` Imports in TS
11
+ or with yarn
10
12
 
11
- TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
13
+ ```bash
14
+ yarn add quail-ui
15
+ ```
12
16
 
13
- If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
17
+ ## Usage
18
+
19
+ Init Quail UI in your main.js file.
20
+
21
+ ```js
22
+ import { createApp } from 'vue'
23
+ import { QuailUI, Icons } from 'quail-ui'
24
+
25
+ // import style
26
+ import 'quail-ui/dist/style.css'
27
+
28
+ // ...
29
+
30
+ const app = createApp(App)
31
+ app.use(QuailUI)
32
+ ```
33
+
34
+ Use the components in your .vue files.
35
+
36
+ ```vue
37
+ <template>
38
+ <div class="image-uploader" :class="rounded? 'rounded':''">
39
+ <QLoading v-if="loading" class="loading-mask"/>
40
+ <QIconCamera class="icon"/>
41
+ </div>
42
+ </template>
43
+ ```
14
44
 
15
- 1. Disable the built-in TypeScript Extension
16
- 1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
17
- 2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
18
- 2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.