# @fileverse-dev/dsheet 中文文档

规范地址：https://npmcn.com/package/%40fileverse-dev/dsheet/

版本：4\.1\.27
npm 元数据更新时间：2026-11-10T15:23:13.517Z
中文译文更新时间：2026-11-14T17:53:58.126Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40fileverse-dev/dsheet
原文对照：https://npmcn.com/package/%40fileverse-dev/dsheet/?lang=original
项目主页：https://github.com/fileverse/fileverse-dsheets#readme
源码仓库：https://github.com/fileverse/fileverse-dsheets

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

- 包体积（解压后）：12.8 MB，436 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：33 个
- peer 依赖：yjs \>=13\.6\.30 \<14，react ^18\.2\.0 \|\| ^19\.0\.0，react-dom ^18\.2\.0 \|\| ^19\.0\.0
- 首次发布：2025-04-21T11:16:04.546Z
- 最新版本发布：2026-11-10T15:23:13.270Z
- 近 30 天下载量：4185（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：1050（近 12 个月 550 个）

## 中文简介

双层

## 安装

```sh
npm install @fileverse-dev/dsheet
```

也可以使用：`pnpm add @fileverse-dev/dsheet`、`yarn add @fileverse-dev/dsheet`、`bun add @fileverse-dev/dsheet`

## README

# 文件向量 d Sheets

[![NPM](https://img.shields.io/npm/v/@fileverse-dev/dsheet)](https://www.npmjs.com/package/@fileverse-dev/dsheet) [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)

[dsheets. new (英语)](http://dsheets.new/) 您的端到端加密替代 Google 工作表 & Excel 。 用它来读取,操控,甚至写出财务数据,实时. 建在与 Ddocs 相同的中间软件上. 新的,应用程序是专注隐私的,主权的, 并给予你完全控制你的数据.

## 其特征包括:

-   端到端加密
-   本地端对端存储( P)
-   查询APIs甚至智能合同的活数据
-   启用暗模式和其他颜色主题
-   使用熟悉的电子表格接口和函数( VLOOKUP, INDEX, MATCH...)
-   Granular 访问权限(例如,查看、评论、编辑、建议访问特定电子邮件地址)

![dsheetsnew](https://github.com/user-attachments/assets/8bd67463-e999-41f4-b414-9d017fbf9466)

## 安装

通过 npm 安装开始 :

```bash
npm install @fileverse-dev/dsheet
```

## 设置

### 1\. 进口

添加下列进口

```typescript
import DsheetEditor from '@fileverse-dev/dsheet';
import '@fileverse-dev/dsheet/styles';
```

### 2\. 配置尾风

添加到您的 `tailwind.config.js`数字 :

```javascript
module.exports = {
  content: [
    "./src/**/*.{js,jsx,ts,tsx}",
    "./node_modules/@fileverse-dev/dsheet/dist/index.es.js"
  ]
}
```

### 3\. 基本用途

```typescript
function App() {
  const [data, setData] = useState({});

  return (
    <DsheetEditor
      isAuthorized={true}
      dsheetId="my-sheet-id"
      onChange={(updateData) => setData(updateData)}
    />
  );
}
```

## 推荐参考

### 必需的道具

| Prop | 类型 | 说明 |
| --- | --- | --- |
| `isAuthorized` | `boolean` | 用户的授权状态 |
| `dsheetId` | `string` | 协作室的独特标识符 |

### 可选道具

| Prop | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `onChange` | `(data: SheetUpdateData, encodedUpdate?: string) => void` | \- 说吧 | 当工作表数据改变时召回 |
| `onContentUpdate` | `() => void` | \- 说吧 | 不编码或重建工作表的廉价节奏回调 |
| `portalContent` | `string` | \- 说吧 | 编码初始工作表数据 |
| `isReadOnly` | `boolean` | `false` | 启用只读模式 |
| `allowComments` | `boolean` | `false` | 启用注释( 需要) `isReadOnly=true`(中文(简体) ) |
| `username` | `string` | \- 说吧 | 协作的用户名 |
| `isCollaborative` | `boolean` | `false` | 启用协作功能 |
| `enableWebrtc` | `boolean` | `true` | 为 P2P 协作启用 WebRTC |
| `enableIndexeddbSync` | `boolean` | `true` | 启用本地索引 DB 持久性 |
| `isTemplateOpen` | `boolean` | \- 说吧 | 模板侧边栏状态 |
| `selectedTemplate` | `string` | \- 说吧 | 选中模板标识符 |
| `onboardingComplete` | `boolean` | \- 说吧 | 登入完成状态 |
| `sheetEditorRef` | `RefObject<WorkbookInstance>` | \- 说吧 | 外部对编辑器实例的对比 |

### 高级道具

| Prop | 类型 | 说明 |
| --- | --- | --- |
| `renderNavbar` | `(editorValues?: EditorValues) => JSX.Element` | 自定义导航条渲染器 |
| `onboardingHandler` | `OnboardingHandlerType` | 自定义登入逻辑 |
| `dataBlockApiKeyHandler` | `DataBlockApiKeyHandlerType` | 数据块的 API 密钥处理器 |
| `getCommentCellUI` | `(row: number, column: number, dragHandler: CommentUIDragFn) => void` | 自定义注释 UI 处理器 |
| `commentData` | `Object` | 单元格注释数据 |
| `toggleTemplateSidebar` | `() => void` | 模板侧边栏切换处理器 |
| `storeApiKey` | `(apiKeyName: string) => void` | API 密钥存储处理器 |
| `onDataBlockApiResponse` | `(dataBlockName: string) => void` | 数据块 API 响应处理器 |
| `onDuneChartEmbed` | `() => void` | 嵌入式处理器 |
| `onSheetCountChange` | `(sheetCount: number) => void` | 工作表计数更改处理器 |

### UI 国道

| Prop | 类型 | 说明 |
| --- | --- | --- |
| `setShowFetchURLModal` | `Dispatch<SetStateAction<boolean>>` | URL 获取模式状态设置器 |
| `setFetchingURLData` | `(fetching: boolean) => void` | URL 正在获取状态设置 |
| `setInputFetchURLDataBlock` | `Dispatch<SetStateAction<string>>` | URL 输入状态设置器 |
| `setForceSheetRender` | `Dispatch<SetStateAction<number>>` | 强制重击触发器 |

## 实例

### 仅读查看器

```typescript
<DsheetEditor
  isAuthorized={true}
  dsheetId="viewer-sheet"
  isReadOnly={true}
  allowComments={true}
  portalContent={encodedData}
  onChange={() => {}}
/>
```

### 协作编辑器

```typescript
<DsheetEditor
  isAuthorized={true}
  dsheetId="collab-sheet"
  username="john-doe"
  isCollaborative={true}
  enableWebrtc={true}
  onChange={(data) => console.log('Sheet updated:', data)}
/>
```

### 自定义导航栏

```typescript
<DsheetEditor
  isAuthorized={true}
  dsheetId="custom-sheet"
  renderNavbar={(editorValues) => (
    <div className="flex items-center gap-4">
      <h1>My Custom Sheet</h1>
      <button onClick={() => editorValues?.sheetEditorRef.current?.exportToExcel()}>
        Export
      </button>
    </div>
  )}
/>
```

### 带有模板

```typescript
<DsheetEditor
  isAuthorized={true}
  dsheetId="template-sheet"
  selectedTemplate="financial-budget"
  isTemplateOpen={true}
  toggleTemplateSidebar={() => setTemplateOpen(!templateOpen)}
/>
```

## 发展

### 运行演示

```bash
cd demo
npm install
npm run dev
```

### 构建软件包

```bash
npm run build
```

## 类型脚本

所有道具全部输入. 导入类型 :

```typescript
import { DsheetProps, SheetUpdateData, EditorValues } from '@fileverse-dev/dsheet/types';
```

## 许可证

AGPL-3.0 导弹

## 常见问题

### @fileverse-dev/dsheet 是什么？

双层

### 如何安装 @fileverse-dev/dsheet？

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

### @fileverse-dev/dsheet 支持 TypeScript 吗？

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

### @fileverse-dev/dsheet 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @fileverse-dev/dsheet 可以商用吗？

@fileverse-dev/dsheet 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @fileverse-dev/dsheet 的下载量有多少？

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

### @fileverse-dev/dsheet 还在维护吗？

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