DCX React Library 开源项目最佳实践教程

1. 项目介绍

DCX React Library 是一个 UI/UX 中立的 React 组件库，旨在为开发者提供一组易于集成到任何项目中的 React 组件。它不包含任何预设的样式，允许开发者根据项目需求自定义组件的样式。DCX React Library 提供了多种组件，并支持通过 CSS 自定义属性进行可选的样式配置。

2. 项目快速启动

环境准备

确保你的开发环境中已安装 Node.js 和 npm。

安装

通过 npm 安装 DCX React Library：

yarn add @capgeminiuk/dcx-react-library

引入组件

在项目中引入所需的组件，例如 Button：

import { Button } from '@capgeminiuk/dcx-react-library';

使用组件

在你的 React 组件中使用 DCX React Library 的 Button 组件：

const App = () => {
  return (
    <Button label="开始" onClick={() => {}} />
  );
};

样式引入

DCX React Library 不包含 CSS，但某些组件需要样式表才能正常工作。你可以按如下方式引入基础样式：

import '@capgeminiuk/dcx-react-library/dist/dcx-react-library.css';

如果你的项目性能要求较高，可以选择按需引入样式表。

3. 应用案例和最佳实践

样式自定义

DCX React Library 允许通过 CSS 自定义属性进行样式定制。以下是一个定制按钮样式的例子：

:root {
  --button-background: #4CAF50;
  --button-color: white;
}

.button {
  background-color: var(--button-background);
  color: var(--button-color);
}

在 React 组件中应用自定义样式：

const ButtonCustom = () => {
  return (
    <Button className="button" label="自定义按钮" onClick={() => {}} />
  );
};

设计系统集成

DCX React Library 支持通过设计系统令牌进行样式定制。你可以按如下方式引入设计系统样式：

import '@capgeminiuk/dcx-react-library/design-system/index.css';

这将为所有组件设置默认样式，你也可以按需引入单独的组件样式。

4. 典型生态项目

DCX React Library 可以与 Storybook 集成，方便开发者展示和测试组件。以下是如何设置 Storybook 的例子：

1. 安装 Storybook：

yarn add @storybook/react @storybook/addon-links @storybook/addon-essentials

2. 在项目中创建 Storybook 配置文件：

npx sb init

3. 编写组件故事：

import React from 'react';
import { Button } from '@capgeminiuk/dcx-react-library';
import { storiesOf } from '@storybook/react';

storiesOf('Button', module).add('with text', () => <Button label="按钮" />);

通过这些步骤，你可以在开源项目中使用 DCX React Library，实现组件的快速开发和样式定制。