@geelato/web-vue
v3.0.0
Published
Geelato Web Vue: a Vue 3 UI component library, forked from Arco Design Vue (MIT, © ByteDance) and modified for the Geelato product line.
Maintainers
Readme
基于 Arco Design 派生(fork)并按 Geelato 业务需求改造的 Vue UI 组件库。
原始开源项目地址:https://github.com/arco-design/arco-design-vue。
完整 API 与设计规范请参考官方文档;本仓库主要记录我们的改造与扩展,所有变更将同步至 CHANGELOG.md。
English | 简体中文
来源说明。
@geelato/web-vue是我们基于 Arco Design Vue 改造的版本,不是字节跳动或 Arco Design 项目发布、维护、审核或背书的产品,也不是@arco-design/web-vue的别名 —— 两者只装一个,同时装会把库和 样式各打进两份。许可与署名见 LICENSE · NOTICE。
复制示例代码时的包名差异
上游文档与网上答案里的示例都是 import ... from '@arco-design/web-vue',在本包中需要替换成
@geelato/web-vue:
- import { Button, Modal } from '@arco-design/web-vue';
- import '@arco-design/web-vue/dist/arco.css';
+ import { Button, Modal } from '@geelato/web-vue';
+ import '@geelato/web-vue/dist/arco.css';子路径形状不变(/es/icon、/es/locale/lang/zh-cn、/dist/arco.css)。
arco- 类名前缀、--arco-* 主题变量、arco-theme 属性以及 dist/arco*.js、dist/arco.css 文件名
有意保留:它们继承自上游,属于主题接口与 CDN 路径,改名会让既有样式和引用链接全部失效,而在许可层面没有任何收益。
特性
全面
60多个开箱即用的高质量组件, 可以覆盖绝大部份的业务场景。
主题配置
海量的样式 tokens, 支持全局以及组件级别的主题配置。有以下2种方式可以定制主题:
- Less-loader
- 风格配置平台 - 推荐!
TypeScript 友好
所有组件都是用 TypeScript 编写的,所以天然的类型友好。
安装
// npm
npm install @geelato/web-vue
// yarn
yarn add @geelato/web-vue例子
import { createApp } from 'vue'
import GeelatoVue from '@geelato/web-vue';
import App from './App.vue';
import '@geelato/web-vue/dist/arco.css';
const app = createApp(App);
app.use(GeelatoVue);
app.mount('#app');开发
使用
npm install -g安装lerna和yarn等基础包使用
yarn install安装workspaces中各个包的依赖(如果遇到YN0018错误,可以使用YARN_CHECKSUM_BEHAVIOR=update yarn进行安装)使用
npm run init初始化项目
变更日志
运行 pnpm -F @geelato/web-vue run changelog 生成并更新 CHANGELOG.md,请在每次功能变更或修复后及时维护变更记录(建议使用 Conventional Commits)。
相关链接
上游文档由 Arco Design 项目托管,并非我们运营,其内容可能滞后于本仓库的改动。本仓库的权威依据是组件源码与
CHANGELOG.md。
上游生态
以下平台属于 Arco Design 项目,不属于本 fork:
| 项目 | 介绍 | | --------------------- | ------------------------------------------------------- | | React 组件库 | 基于 Arco Design 的 React UI 组件库。 | | 风格配置平台 | 精确到组件级的主题视觉配置平台 | | 物料平台 | 上游 Arco Design 项目提供的业务定制物料平台 | | 图标平台 | 一站式图标管理平台 | | Arco Pro | 快速构建中后台的前端解决方案 |
参与贡献
感谢所有为上游 Arco Design Vue 项目做过贡献的人!
许可与署名
本包以 MIT 许可证 发布:
- 原始作品:
Copyright (c) 2021 Bytedance, Inc. and its affiliates.—— 上游版权与许可声明原文保留,未被本 fork 修改。 - 我们的修改:
Copyright (c) 2025-present The Geelato Web Vue Authors.
溯源与商标条款见 NOTICE。"Arco"、"Arco Design"、"ByteDance" 为各自权利人的商标;MIT 许可证只授予 著作权许可,不授予商标许可,这些名称在本包中仅用于标识代码来源。
