Stitches.js 开源项目快速指南

本指南旨在帮助开发者深入了解 Stitches.js 的核心结构与配置，使您能够快速上手并高效地在项目中应用这一强大的 CSS-in-JS 库。

1. 项目目录结构及介绍

Stitches.js 的 GitHub 仓库并不直接体现一个典型的项目结构，而是提供了库本身的所有源代码和相关资源。不过，当在自己的项目中集成 Stitches 时，可以遵循以下推荐的目录布局：

• src: 这是放置您的 Stitches 配置、组件以及主题文件的理想位置。

  • styles: 存放所有自定义样式的文件夹。
    • global.css: 可用于放置全局样式，尽管 Stitches 提供更细粒度的控制，但传统全局样式仍可用。
  • stitches.config.js: 核心配置文件。
  • components: 组件文件夹，利用 Stitches 构建的自定义 UI 组件。

• public: 如果在 Web 项目中，这通常存放静态资源，如 favicon 和 HTML 入口文件。

2. 项目的启动文件介绍

在使用 Stitches 的项目中，并没有特定的“启动文件”概念，因为它是以 Node.js 模块的方式集成到项目中的。不过，项目的主要入口点（通常是 index.js 或 main.js）会引入 Stitches 的配置并开始使用它。例如，一个简单的启动逻辑可能涉及：

import { styled } from 'stitches.config.js';

const App = styled('div', {
  backgroundColor: 'white',
  padding: '1rem',
});

function MyApp() {
  return <App>Hello, World!</App>;
}

export default MyApp;

这里假设您已经在项目的配置文件中设置了必要的 Stitches 配置。

3. 项目的配置文件介绍

stitches.config.js

这是 Stitches 的心脏，定义了如何处理你的 CSS。一个基本的 stitches.config.js 文件示例可能会包含：

import { config } from '@stitches/react';

export const stitchesConfig = config({
  content: ['./src/**/*.{js,ts,jsx,tsx}'],
  theme: {
    colors: {
      red: '#FF0000',
      blue: '#0000FF',
    },
    space: {
      xs: '4px',
      sm: '8px',
      md: '16px',
      lg: '32px',
    },
    fonts: {
      sans: '-apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,Oxygen-Sans,Ubuntu,Cantarell,"Helvetica Neue",sans-serif',
    },
  },
  media: {
    sm: '(min-width: 640px)',
    md: '(min-width: 768px)',
    lg: '(min-width: 1024px)',
    xl: '(min-width: 1280px)',
  },
});

该配置文件允许你设置主题变量、媒体查询断点、编译选项等，确保 Stitches 能按你的需求生成样式。

---

以上概览提供了一个关于如何组织项目以使用 Stitches.js，以及配置其核心组件的基础框架。实际使用中，请参考 Stitches 官方文档进行详细学习和实践。