# @getflywheel/local-components 中文文档

规范地址：https://npmcn.com/package/%40getflywheel/local-components/

版本：17\.8\.2
npm 元数据更新时间：2026-09-04T18:58:20.817Z
中文译文更新时间：2026-11-16T06:10:57.059Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40getflywheel/local-components
原文对照：https://npmcn.com/package/%40getflywheel/local-components/?lang=original
项目主页：https://localwp.com/help-docs/
源码仓库：https://github.com/getflywheel/local-components

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：3.3 MB，1103 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：21 个
- peer 依赖：react \>= 16\.9\.0，react-dom \>= 16\.9\.0，react-router-dom ^5\.0\.1
- 首次发布：2018-11-30T22:20:55.621Z
- 最新版本发布：2026-07-14T12:14:39.579Z
- 近 30 天下载量：3755（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：234（近 12 个月 1 个）

## 中文简介

ya# 本地组件库

## 安装

```sh
npm install @getflywheel/local-components
```

也可以使用：`pnpm add @getflywheel/local-components`、`yarn add @getflywheel/local-components`、`bun add @getflywheel/local-components`

## README

ya# 本地组件库

[![npm version](https://badge.fury.io/js/%40getflywheel%2Flocal-components.svg)](https://badge.fury.io/js/%40getflywheel%2Flocal-components)

欢迎使用官方组件库 [当地](https://localwp.com/)来啊!

## 这个组件库包括什么?

我们欣赏好奇心,这是个好问题! 快看我们的活文件 [这里](https://master--62d18352969d7c650b935483.chromatic.com/)。 。 。 .

除了快速增长的回放组件外,我们还有SVG,SASS部分,还有更多即将到来的!

## 故事书

最快速的工作方式 `local-components` 是用来杠杆 [故事书](https://storybook.js.org/)故事书是 本地开发区与React组件合作良好,支持热模块重载.

要开始故事本, 运行 `yarn storybook`。或者,从本地的根,运行 `nps storybook`。 。 。 .

## 地方内部的发展

`local-components` 现在是一个本地核心的工作空间, 表示您可以正常地开发 `nps build.dev` 使软件包在监视模式下被构建. `yarn install` 只要根和包的版本 `package.json` 相匹配的。 匹配的.

## 深入挖掘

这个 `local-components` 库可细分为三个主要部分:

1.  [构成部分](https://npmcn.com/package/%40getflywheel/local-components/#readme-components)
2.  [样式](https://npmcn.com/package/%40getflywheel/local-components/#readme-styles)
3.  [SVGs 组合](https://npmcn.com/package/%40getflywheel/local-components/#readme-svgs)

### 构成部分

这些是视觉元素,既构成本地元素,又构成其加成元素. 目前库有40+回放组件. 每一组成部分由下列部分组成: `.tsx`, (中文(简体) ), `index.js`, (中文(简体) ), `README.md` 和可选 `.sass` 文档.

你自己试试看!

1.  通过其 `.tsx` 财务报告和审定财务报表 `.sass` 文件( 它们应该重新装入)
2.  随处游玩在 `README.md` 文件

> 注:所有组件和样式的切入点是: `index.ts`。 。 。 .

#### 容器包装器

几个组成部分利用 `Container.tsx` 组成部分,以完成它们自己的执行. 集装箱是一个高度专业化的部件,可以切入(外接部分中的包装内容)或切出(不外接部分). 此外,"集装箱包装"还增加了便利道具,可以方便地进行一次性调整,比如添加了3px的比值而不会与内部内容的类别和样式相冲突.

> 注意:设置任何容器道具将自动切入(失效:虚假)容器,从而将内装物包裹在容器包装上.

#### 组织

部件按类型排列。 这些类型组在运行"故事本"时可以看到.

### 样式

#### 套装 CSS

取名难取. 也没有完美的系统. 这么说,我们选择了 [套装 CSS](https://suitcss.github.io/) 用于命名会议.

> 注:由于遗留的包件有限,当地部件使用下划线,而不是破折号.

#### CSS 模块

组件库利用CSS模块来管理和范围样式. 这些都是考虑的 **当地** 样式( 不与本地应用程序相混淆 ) 范围化的本地风格是一件美丽的东西,它允许本地分离组件,运行带有多个版本的Add-ons `local-components` 并避免相撞.

与本地风格一样美妙, CSS 也有一些需要超越单一组件的例子. 为此,我们利用 **全球** 样式. 全球风格应被大多数人所熟悉,因为网络主要使用20多年. Global 风格在使用 Add-ons 和 Environments 的库来缩放一个应用时会引入很多挑战.

以下是一个实例,其中范围化的组件可能使用局部和全局风格的组合来实现特定结果:

```css
:global(.WindowsToolbar .DragRegion)
```

这是我们试图避免的事物,并且正在积极地努力把基本内容降低到最低限度.

请检查cSS模块 [这里](https://github.com/css-modules/css-modules)。 。 。 .

Webpack 编译所有样式 `scoped.css`中包含的 `<style>` core app的浏览器窗口 HTML 的标签.

#### SASS 部分、混合和函数

使用着一个广泛的sass系统,即使不是大多数,也是许多组件的杠杆作用.

##### 部分

如果你寻找 `_partials` 目录中,您将找到变量、组合、函数和其他共享资源.

##### 变量

如果局部使用一种颜色,则它被定义为在 `_variables.scss` 文档. 此外,这里还有字体,字体大小,字体权重,和边距/铺设预设值等.

> 注:字体西斯和边距/平面使用T恤尺寸表示相对尺寸,同时遵守严格的设计标准/价值.

##### 主题

当地有光和暗两种模式. 由于这影响到每个组成部分 `_theme.scss` 文件包含 混合,以可重复和可预测的方式简化这些变化的实施.

当你可以杠杆 `if-theme-light` 财务报告和审定财务报表 `if-theme-dark` 直接来说,大多数轻/暗的组合都遵循一个特定的模式,因此具有专用的混合. 例如 `theme-color-black-else-white` 混合应用 `color` 黑色的样式(如果光),否则为白色(如果暗). 另一个例子是: `theme-background-green-else-graydark` 混合应用 `background` 绿色的样式(如果是光),否则是灰色的(如果是暗的).

> 注意: 轻/暗模式样式是通过拖动添加到该模式的类来应用的 `html` 元素(例如主题 Light).

### SVGs 组合

马上就来!

## 许可证

[麻省理工学院](https://npmcn.com/package/%40getflywheel/local-components/LICENSE)

## 常见问题

### @getflywheel/local-components 是什么？

ya\# 本地组件库

### 如何安装 @getflywheel/local-components？

在项目目录运行 npm install @getflywheel/local-components，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>= 16\.9\.0）、react-dom（\>= 16\.9\.0）、react-router-dom（^5\.0\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @getflywheel/local-components 支持 TypeScript 吗？

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

### @getflywheel/local-components 支持 ESM 还是 CommonJS？

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

### @getflywheel/local-components 可以商用吗？

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

### @getflywheel/local-components 的下载量有多少？

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

### @getflywheel/local-components 还在维护吗？

最新版本 17\.8\.2 发布于 2026/07/14（4 个月前）；至今共发布 234 个版本，其中过去 12 个月发布了 1 个；首次发布于 2018/12/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

