Skip to content

Rhh-Z/viray

Repository files navigation

VIRAY

  • 💪 Vue 3 Composition API
  • 🔥 Written in TypeScript

安装

PNPM安装

推荐使用 pnpm 的方式安装

pnpm i viray -S

其他安装方式

npm i viray -S
yarn add viray -S

快速开始

完整引入

如果你对打包后的体积大小不是很在乎,那么使用完整导入会更方便。

// main.ts
import { createApp } from 'vue';
import App from './App.vue';
import viray from 'viray';
const app = createApp(App);
app.use(viray).mount('#app');

按需引入

// main.ts
import { createApp } from 'vue';
import App from './App.vue';
import {ViButton} from 'viray';
const app = createApp(App);
app.use(ViButton).mount('#app');

使用

<template>
    <vi-button type="primary">primary</vi-button>
</template>

其他组件和具体用法请启动文档

pnpm docs:dev

仓库相关命令

安装 pnpm

pnpm i pnpm -g

安装所有依赖

pnpm install

启动本地测试项目

cd ./play
pnpm run dev

打包组件库

pnpm run build:viray

启动文档

pnpm run docs:dev

单元测试

pnpm run test

查看测试覆盖率

pnpm run coverage