SumUp Circuit UI 开源项目教程
circuit-ui SumUp's design system for the web 项目地址: https://gitcode.com/gh_mirrors/ci/circuit-ui
1. 项目介绍
SumUp Circuit UI 是 SumUp 公司为 Web 开发设计的设计系统实现。其主要目标是创建一个能够用于构建各种 SumUp 网站和应用的系统,同时为用户提供一致且包容的用户体验。该设计系统不仅易于开发人员使用,还为设计师提供了便利。
2. 项目快速启动
2.1 安装 Circuit UI
首先,确保你已经安装了 Node.js 和 npm。然后,你可以通过 npm 或 yarn 安装 Circuit UI:
npm install @sumup/circuit-ui
或者
yarn add @sumup/circuit-ui
2.2 在项目中使用 Circuit UI
在你的 React 项目中,你可以像使用其他 React 组件库一样使用 Circuit UI 组件。例如,使用一个按钮组件:
import React from 'react';
import { Button } from '@sumup/circuit-ui';
function App() {
return (
<div>
<Button onClick={() => alert('Hello, Circuit UI!')}>
Click Me
</Button>
</div>
);
}
export default App;
2.3 配置主题
Circuit UI 支持自定义主题。你可以在项目中创建一个主题文件,并将其应用到你的应用中:
import { ThemeProvider } from '@sumup/circuit-ui';
import { theme } from '@sumup/design-tokens';
function App() {
return (
<ThemeProvider theme={theme}>
{/* 你的应用代码 */}
</ThemeProvider>
);
}
export default App;
3. 应用案例和最佳实践
3.1 构建一致的用户界面
使用 Circuit UI 可以帮助你在多个项目中保持一致的用户界面。例如,你可以使用相同的按钮、表单和导航组件,确保用户在不同产品中获得一致的体验。
3.2 自定义组件
Circuit UI 提供了丰富的组件库,但你也可以根据需要自定义组件。通过使用 styled-components
或其他 CSS-in-JS 库,你可以轻松地扩展和修改现有组件。
import styled from 'styled-components';
import { Button } from '@sumup/circuit-ui';
const CustomButton = styled(Button)`
background-color: #ff6347;
color: white;
`;
function App() {
return (
<div>
<CustomButton onClick={() => alert('Custom Button!')}>
Custom Button
</CustomButton>
</div>
);
}
export default App;
4. 典型生态项目
4.1 @sumup/design-tokens
@sumup/design-tokens
是 Circuit UI 的设计令牌库,包含了颜色、间距、字体等视觉原语。你可以使用这些设计令牌来保持设计的一致性。
4.2 @sumup/icons
@sumup/icons
是一个 SVG 图标集合,可以与 Circuit UI 组件一起使用,增强用户界面的视觉效果。
4.3 @sumup/cna-template
@sumup/cna-template
是一个 Next.js 应用模板,集成了 Circuit UI 和 Foundry,帮助你快速启动一个新的 Next.js 项目。
通过这些生态项目,你可以更高效地构建和维护基于 Circuit UI 的应用。
circuit-ui SumUp's design system for the web 项目地址: https://gitcode.com/gh_mirrors/ci/circuit-ui