Quark Design 开源项目教程

1. 项目介绍

Quark Design 是由哈啰平台 UED 和增长&电商前端团队联合打造的一套面向移动端的跨框架 UI 组件库。它基于 Web Components 实现，能够做到一套代码同时运行在各类前端框架中，如 Vue、React、Angular 等。Quark Design 旨在提供一套轻量、快速、跨框架的组件库，满足企业级应用的需求。

2. 项目快速启动

安装

首先，你需要安装 Quark Design 的依赖包。你可以使用 npm 或 yarn 进行安装：

npm install quarkd

或者

yarn add quarkd

使用示例

安装完成后，你可以在项目中引入并使用 Quark Design 的组件。以下是一个简单的使用示例：

import "quarkd/lib/button";

// 在 HTML 中使用
<quark-button type="primary" onclick="onClick">Button</quark-button>

// 在 React 中使用
<quark-button type="primary" onClick={onClick}>Button</quark-button>

// 在 Vue 中使用
<quark-button type="primary" @click="onClick">Button</quark-button>

// 在 Svelte 中使用
<quark-button type="primary" on:click={onClick}>Button</quark-button>

// 在 Angular 中使用
<quark-button type="primary" (click)="onClick">Button</quark-button>

启动项目

如果你想要快速启动一个基于 Quark Design 的项目，可以使用以下命令：

npx create-quark-app project-name
cd project-name
npm run dev

3. 应用案例和最佳实践

应用案例

Quark Design 已经在哈啰集团内部大量业务中得到验证，包括交易、支付、两轮、商城等 C 端 H5 项目。它提供了一套设计轻盈优雅的企业级 UI 组件库，能够满足日常所需所有基础组件。

最佳实践

1. 跨框架使用：Quark Design 支持在不同前端框架中使用，确保在多技术栈环境中保持视觉和交互的一致性。
2. 按需引用：你可以根据项目需求选择性地引入组件，避免不必要的资源加载。
3. 定制主题：Quark Design 支持定制主题，满足不同项目的视觉需求。

4. 典型生态项目

Quark Design 不仅提供了一套基础的 UI 组件库，还提供了开箱即用的 CLI 工具，帮助开发者在日常开发中开发横跨多个技术栈/框架的业务组件。以下是一些典型的生态项目：

• Quark CLI：用于创建和管理 Quark Design 项目的命令行工具。
• Quark Components：提供了一系列基础和高级组件，满足不同业务需求。
• Quark Documentation：详细的文档和示例，帮助开发者快速上手和使用 Quark Design。

通过这些生态项目，Quark Design 能够帮助企业在前端开发中提效降本，实现技术栈无关的组件开发和使用。