Code Connect 开源项目教程

Code Connect 开源项目教程

code-connectA tool for connecting your design system components in code with your design system in Figma项目地址:https://gitcode.com/gh_mirrors/co/code-connect

项目介绍

Code Connect 是一个用于将设计系统组件在代码中与 Figma 中的设计系统连接的工具。通过使用 Code Connect，Figma 的开发模式将显示与生产环境一致的代码片段，而不是自动生成的代码示例。Code Connect 支持 React（及 React Native）、Storybook、SwiftUI 和 Jetpack Compose，并且易于设置和维护，类型安全且可扩展。

项目快速启动

安装 Node.js

首先，确保你的计算机上安装了 Node.js v16 或更高版本。你可以通过运行以下命令检查是否已安装 Node.js 及其版本：

node -v

如果需要安装 Node.js，可以在 Node.js 官网 找到适用于所有平台的安装说明。

全局安装 Code Connect

安装 Node.js 后，你可以全局安装 Code Connect，以便从任何位置运行它：

npm install --global @figma/code-connect

在 React 项目中安装 Code Connect

如果你有一个 React 项目，可以按照以下步骤安装 Code Connect：

1. 克隆项目仓库：

   git clone https://github.com/figma/code-connect.git
   

2. 进入项目目录：

   cd code-connect
   

3. 安装依赖：

   npm install
   

4. 启动项目：

   npm start
   

应用案例和最佳实践

动态和正确示例

Code Connect 支持从代码映射属性到 Figma，从而实现动态和正确的示例。这对于当你有一个现有的设计系统并希望在设计和工程之间推动一致和正确的采用非常有用。

配置文件

Code Connect 可以通过 figma-config.json 文件进行配置，该文件必须位于项目根目录中。例如：

{
  "codeConnect": {
    "documentUrlSubstitutions": {
      "https://figma.com/design/1234abcd/File-1": "https://figma.com/design/5678dcba/File-2"
    }
  }
}

典型生态项目

React 和 React Native

Code Connect 提供了对 React 和 React Native 的支持，使得在 Figma 中设计的内容可以无缝转换为 React 组件。

SwiftUI

对于使用 SwiftUI 的开发者，Code Connect 提供了与 Figma 设计系统的直接连接，确保设计与代码的一致性。

Jetpack Compose

Jetpack Compose 是 Android 的现代 UI 工具包，Code Connect 支持将 Figma 设计系统与 Jetpack Compose 集成，提供一致的开发体验。

通过以上步骤和配置，你可以快速启动并使用 Code Connect 项目，实现设计系统与代码的无缝连接。

code-connectA tool for connecting your design system components in code with your design system in Figma项目地址:https://gitcode.com/gh_mirrors/co/code-connect