# @bimetal/kanban-react-components 中文文档

规范地址：https://npmcn.com/package/%40bimetal/kanban-react-components/

版本：0\.42\.0
npm 元数据更新时间：2026-10-30T11:44:04.248Z
中文译文更新时间：2026-11-08T02:59:03.021Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40bimetal/kanban-react-components
原文对照：https://npmcn.com/package/%40bimetal/kanban-react-components/?lang=original

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

- 包体积（解压后）：61.1 kB，29 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，react-dom ^18\.0\.0 \|\| ^19\.0\.0
- 首次发布：2026-07-15T18:08:59.422Z
- 最新版本发布：2026-10-30T11:44:04.063Z
- 近 30 天下载量：7980（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

默认回放 kanban 棋盘 – 真正的指针和键盘拖放,列, WIP, 标签, 主题, 可自定义的牌.

## 安装

```sh
npm install @bimetal/kanban-react-components
```

也可以使用：`pnpm add @bimetal/kanban-react-components`、`yarn add @bimetal/kanban-react-components`、`bun add @bimetal/kanban-react-components`

## README

# @ bimetal/ kanban- react- 组件

默认 **反弹 Kanban 板** 对BIMETAL公司来说——薄的捆绑 犬类 [`@bimetal/kanban-headless`](https://npmcn.com/package/%40bimetal/kanban-headless) 控制器。 控制器。 每个 互动决定(破碎阈值、下降指数、WIP拒绝、取消) 在无头控制器中; 此软件包只拥有 DOM: 命中测试指针 拖放,使键盘事件正常化,并渲染.

## 特征

-   **真实的拖放** ——指针被拖过并被拖入列内,有活口 滴出gap指标。 无每张卡移动按钮 .
-   **键盘 a11y** - 拿张卡 空间移动它与 箭头键(xq/ ) 横跨列,qq/ 内部),以 空间编号 :输入, (中文(简体) ), 取消为 英格兰。 。 。 . `aria-grabbed` 反映持有的卡片.
-   **列数** 添加、重命名内线、重排、删除(卡级联) 每栏 **WIP 限制** 他们拒绝超限的举动.
-   **纸牌** 标题、说明、, **标签**; 全文 **海关卡机构** 通过 `renderCard` 而拖放/焦点包装仍为组件所拥有.
-   **过滤, 撤销, 主题** - 标题/说明/标签上的文本过滤器,a 一击取消土司, 和一个轻/暗的符号集从 `@bimetal/kanban-themes`。 。 。 .

建于事件源: 整块板是一个集合, 每个变化都是一个 并取消 + 完整历史来免费.

## 使用量

```tsx
import { Kanban } from '@bimetal/kanban-react-components';
import { createKanbanStore } from '@bimetal/kanban-data';

const store = createKanbanStore();
// …seed the board…

function App() {
  return <Kanban store={store} boardId="board-1" />;
}
```

自定义牌体 :

```tsx
<Kanban
  store={store}
  boardId="board-1"
  darkMode
  renderCard={(card) => <MyCard card={card} />}
/>
```

## 道具

| Prop | 类型 | 页:1 |
| --- | --- | --- |
| `store` | `KanbanStore` | 董事会商店. 上山后无法改变. |
| `boardId` | `string` | 哪个板子可以制成。 上山后无法改变. |
| `config` | `KanbanConfigInput?` | 地域覆盖,与默认合并. |
| `darkMode` | `boolean?` | 应用暗号集 . |
| `showFilter` | `boolean?` | 显示工具栏过滤器( 默认) `true`) (中文(简体) ). |
| `renderCard` | `(card: Card) => ReactNode` | 定制牌体. |
| `onError` | `(err: unknown) => void` | 基础设施错误( WIP 拒绝是不可撤销的祝词,而不是错误). |

## 许可证

阿帕奇 - 2.0

## 常见问题

### @bimetal/kanban-react-components 是什么？

默认回放 kanban 棋盘 – 真正的指针和键盘拖放,列, WIP, 标签, 主题, 可自定义的牌\.

### 如何安装 @bimetal/kanban-react-components？

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

### @bimetal/kanban-react-components 支持 TypeScript 吗？

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

### @bimetal/kanban-react-components 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bimetal/kanban-react-components 可以商用吗？

@bimetal/kanban-react-components 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bimetal/kanban-react-components 的下载量有多少？

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

### @bimetal/kanban-react-components 还在维护吗？

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