Dessert Box 项目教程

最新推荐文章于 2024-09-26 07:16:56 发布

黎启炼

最新推荐文章于 2024-09-26 07:16:56 发布

阅读量550

点赞数 13

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00942/article/details/142014531

Dessert Box 项目教程

dessert-boxAn utility to create a Box component from your vanilla-extract + sprinkles tokens.项目地址:https://gitcode.com/gh_mirrors/de/dessert-box

1. 项目的目录结构及介绍

Dessert Box 项目的目录结构如下：

dessert-box/
├── src/
│   ├── atoms.css.ts
│   ├── Box.tsx
│   ├── styledComponents.css.ts
│   └── App.tsx
├── package.json
├── tsconfig.json
├── README.md
└── ...

目录结构介绍

src/: 项目的源代码目录，包含主要的 TypeScript 文件。
- atoms.css.ts: 定义了原子样式（atoms）的文件，使用 vanilla-extract 和 sprinkles 创建。
- Box.tsx: 创建 Box 组件的文件，使用 createBox 函数。
- styledComponents.css.ts: 定义了 styled-components 风格的组件。
- App.tsx: 项目的入口文件，展示了如何使用 Box 组件。
package.json: 项目的依赖管理文件，包含了项目的依赖包和脚本命令。
tsconfig.json: TypeScript 的配置文件，定义了 TypeScript 编译器的选项。
README.md: 项目的说明文档，包含了项目的介绍、安装和使用方法。

2. 项目的启动文件介绍

项目的启动文件是 src/App.tsx，它是项目的入口文件，展示了如何使用 Box 组件。

// src/App.tsx
import React from 'react';
import { StyledHeadline } from './styledComponents.css';

function App() {
  return (
    <StyledHeadline>I have 0 runtime styles 🤯</StyledHeadline>
  );
}

export default App;

启动文件介绍

App.tsx: 这是项目的入口文件，使用了 StyledHeadline 组件，展示了如何在没有运行时样式的情况下使用组件。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的依赖包和脚本命令。

{
  "name": "dessert-box",
  "version": "1.0.0",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "test": "react-scripts test",
    "eject": "react-scripts eject"
  },
  "dependencies": {
    "@dessert-box/react": "^1.0.0",
    "react": "^17.0.2",
    "react-dom": "^17.0.2",
    "react-scripts": "4.0.3"
  },
  "devDependencies": {
    "@types/react": "^17.0.3",
    "@types/react-dom": "^17.0.3",
    "typescript": "^4.2.3"
  }
}

tsconfig.json

tsconfig.json 文件定义了 TypeScript 编译器的选项。

{
  "compilerOptions": {
    "target": "es5",
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "noFallthroughCasesInSwitch": true,
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react-jsx"
  },
  "include": ["src"]
}