@graylog/sawmill

中文文档
4.0.11发布于 2026/08/27MITTypeScriptCommonJS构建来源已验证近 30 天下载 1.2万

Graylog 的设计系统和组件库

中文使用文档
文档目录8 节
  1. 使用锯木机
  2. 安装软件包
  3. 字体配置
  4. 设置主题提供者
  5. 导入字体
  6. 作出改变
  7. 建设图书馆
  8. 本地测试更改

锯木厂

Graylog通用设计系统. 这个软件包提供了mantine(SawmillMantine)和有风格的组件(SawmillSC)主题.

使用锯木机

安装软件包

$ yarn add @graylog/sawmill

字体配置

软件包安装后,您需要调整样式化组件类型声明 @types/styled-components/index.d.ts,如果您需要使用有样式的部件锯木厂(SawmillSC):

import 'styled-components';
import type { StyledComponentsTheme } from '@graylog/sawmill/styled-components';

declare module 'styled-components' {
  export interface DefaultTheme extends StyledComponentsTheme {}
}

设置主题提供者

每个锯木厂为相关主题提供者提供主题:

import SawmillMantine from '@graylog/sawmill/mantine';
import type { ColorScheme } from '@graylog/sawmill';

const AppThemeProvider = ({ children }: React.PropsWithChildren<{}>) => {
  const [colorScheme, setColorScheme] = useState<ColorScheme>(DEFAULT_THEME_MODE);
  const mantineTheme = useMemo(
    () => SawmillMantine({ colorScheme }),
    [colorScheme],
  );
  
  return <MantineProvider theme={mantineTheme}>{children}</MantineProvider>
}

导入字体

要导入锯木厂主题中定义的字体, 请包括 import '@graylog/sawmill/fonts' 在你的项目.

作出改变

风格的构件和曼汀锯木厂的基础就是 THEME_BASE.ts 文档. 当你改变这个主题基础时,你需要运行 yarn generate-themes 生成每个锯木厂的主题.

建设图书馆

要建立您需要运行的图书馆 :

$ yarn build # Compile source with tsc and generate `dist` files.

本地测试更改

当您想要在本地测试更改时, 您需要临时添加本地寄存器, 作为您项目的依赖 :

yarn add file:/path/to/this/project

版本与发布记录

@graylog/sawmill 共发布 43 个版本,首次发布于 2023/03/24;过去 12 个月发布了 7 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.0.11latest2026/08/272 个月前
4.0.102026/07/283 个月前
4.0.92026/07/223 个月前
4.0.82026/07/094 个月前
4.0.72026/06/115 个月前
4.0.62026/05/046 个月前

关于 @graylog/sawmill 的常见问题

@graylog/sawmill 是什么?

Graylog 的设计系统和组件库

如何安装 @graylog/sawmill?

在项目目录运行 npm install @graylog/sawmill,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:chroma-js(^3.2.0)、react(>=16.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graylog/sawmill 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@graylog/sawmill 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@graylog/sawmill 可以商用吗?

@graylog/sawmill 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@graylog/sawmill 的下载量有多少?

根据 npm 官方下载统计,@graylog/sawmill 在 2026/10/17 – 2026/11/15 这 30 天内被下载 12,256 次,日均约 409 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@graylog/sawmill 还在维护吗?

最新版本 4.0.11 发布于 2026/08/27(2 个月前);至今共发布 43 个版本,其中过去 12 个月发布了 7 个;首次发布于 2023/03/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。