3.3 KiB

Raw Permalink Blame History

Farris UI Vue

Farris UI Vue 是一套基于Farris Design 的 Vue3 组件库。

English | 简体中文

Farris 设计原则：

Fast : Farris UI 是一套具有急速用户体验的 UI 套件，Farris Data Grid 在渲染大量数据时具有高速渲染性能
Reliable : 我们为用户提供可靠的使用体现，对各类异常交互场景做出针对性的优化
Responsive : 增强的响应式设计，在组件内部提供更细腻的响应式交互
Intuitive : 采用直觉化的设计，向用户更准确的传达界面交互
Smart : 智能化的 UI，满足开发智能应用的场景

1. 了解 Farris

可以访问我们的官方站点(https://farris-design.gitee.io/farris-vue)了解 Farris UI Vue 组件。

2. 如何本地运行项目

2.1 检查环境

在本地运行项目前，请先执行以下命令，检查环境中是否已经安装 yarn。

yarn -v

如果未得到yarn版本信息，请参考安装 yarn.

2.2 获取源代码

执行以下命令，获取项目源代码，并安装依赖组件。

npm install lerna -g
git clone https://gitee.com/ubml/farris-vue.git
cd farris-vue
lerna bootstrap

2.3 运行示例站点

执行以下命令。

cd packages/ui-vue
yarn run docs:dev

在浏览器中访问：http://localhost:5173/ 查看示例页面。

2.4 使用示例站点

你可以访问示例页面站点：

点击「快速开始」了解如何安装使用 Farris UI Vue。
点击「组件」体验组件视觉和交互效果，查看组件 API 说明文档。

3. 如何使用 Farris UI Vue

3.1 安装@farris/ui-vue

npm install @farris/ui-vue

yarn add @farris/ui-vue

3.2 在应用中引入 Farris UI Vue

在main.ts文件中引入@farris/ui-vue。

import { createApp } from 'vue';
import App from './App.vue';
import Farris from '@farris/ui-vue';

createApp(App).use(Farris).mount('#app');

3.3 在应用中使用 Farris UI Vue

在App.vue文件中使用 Farris UI Vue 组件。

<template>
    <f-button-edit></f-button-edit>
</template>

4. 如何参与贡献

还原你参与贡献 Farris UI Vue 在这里你可以参与以下贡献内容：

使用 TypeScript + TSX + SystemJs + Rollup 技术开发 Farris Vue 组件
参与贡献 Farris UI 主题工具
参与贡献 Farris UI 开发文档

如果你决定参与贡献 Farris UI Vue，可以先从阅读我们的贡献指南开始。

✨ 贡献者

感谢以下 Farris UI Vue 的贡献者

开源许可

Apache License 2.0

3.3 KiB Raw Permalink Blame History Unescape Escape