# @friendofsvelte/mermaid 中文文档

规范地址：https://npmcn.com/package/%40friendofsvelte/mermaid/

版本：0\.0\.4
npm 元数据更新时间：2025-09-04T03:50:05.769Z
中文译文更新时间：2026-11-15T14:15:04.250Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40friendofsvelte/mermaid
原文对照：https://npmcn.com/package/%40friendofsvelte/mermaid/?lang=original
项目主页：https://mermaid-cjv.pages.dev/
源码仓库：https://github.com/friendofsvelte/mermaid

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

- 包体积（解压后）：10.6 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：svelte ^5\.0\.0
- 首次发布：2025-08-29T12:26:55.530Z
- 最新版本发布：2025-09-04T03:50:05.586Z
- 近 30 天下载量：9565（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

Svelte 5具有强大的,型号安全的美人鱼.js组件,具有SSS支持,自定义主题,以及响应性设计.

## 安装

```sh
npm install @friendofsvelte/mermaid
```

也可以使用：`pnpm add @friendofsvelte/mermaid`、`yarn add @friendofsvelte/mermaid`、`bun add @friendofsvelte/mermaid`

## README

# @ friendofsvelte/ 美容师

Svelte 5具有强大的,型号安全的美人鱼.js组件,具有SSS支持,自定义主题,以及响应性设计.

[![npm version](https://badge.fury.io/js/@friendofsvelte%2Fmermaid.svg)](https://badge.fury.io/js/@friendofsvelte%2Fmermaid) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## 特征

-   ⚡ **闪电快** - 动态进口和优化渲染
-   🎨 **完全自定义** - 完成主题控制和配置
-   📱 **反应准备** - 内在反应行为
-   🔒 **类型安全** - 严格打字的完整类型脚本支持
-   🧪 **测试友好** - 用Playwright测试的E2E
-   🚀 **SSR 兼容性** - 与SvelteKit SSR和静电发电公司合作

## 安装

```bash
npm install @friendofsvelte/mermaid
```

## 快速启动

```svelte
<script>
  import { Mermaid } from '@friendofsvelte/mermaid';
  
  const diagram = `graph TD
    A[Start] --> B[Process]
    B --> C[End]`;
</script>

<Mermaid string={diagram} />
```

## 高级使用

```svelte
<script>
  import { Mermaid } from '@friendofsvelte/mermaid';
  import type { MermaidConfig } from '@friendofsvelte/mermaid';
  
  const config: MermaidConfig = {
    theme: 'dark',
    flowchart: {
      useMaxWidth: true,
      htmlLabels: true
    }
  };
  
  const diagram = `sequenceDiagram
    participant A as Alice
    participant B as Bob
    A->>B: Hello Bob!
    B-->>A: Hello Alice!`;
</script>

<Mermaid string={diagram} {config} />
```

## API 参考

### 道具

| Prop | 类型 | 需求 | 说明 |
| --- | --- | --- | --- |
| `string` | `string` | 对 | 美人鱼图定义字符串 |
| `config` | `MermaidConfig` | 没有 | 美人鱼配置选项 |
| `error` | `Snippet<[MermaidError]>` | 没有 | 显示片段出错 |

### 类型

```typescript
interface MermaidConfig {
  theme?: 'default' | 'dark' | 'forest' | 'neutral' | 'base';
  flowchart?: {
    useMaxWidth?: boolean;
    htmlLabels?: boolean;
    curve?: string;
  };
  sequence?: {
    useMaxWidth?: boolean;
    actorMargin?: number;
  };
  // ... and more
}

interface MermaidError {
  message: string;
  stack?: string;
}
```

## 支持的图表类型

-   **流程图** - 流程和决策树
-   **序列图** - API互动和工作流程
-   **甘特图** - 项目时间表和时间安排
-   **用户行进图** - UX流动和客户经验
-   **实体关系图** - 数据库计划
-   **图形** - 版本控制工作流程
-   **派图** - 数据可视化
-   **类图** - 面向对象的设计

## 实例

### 自定义 主题

```svelte
<script>
  import { Mermaid } from '@friendofsvelte/mermaid';
  
  const customConfig = {
    theme: 'dark',
    flowchart: {
      useMaxWidth: true,
      htmlLabels: true,
      curve: 'basis'
    }
  };
</script>

<Mermaid string={diagram} config={customConfig} />
```

### 处理错误

```svelte
<script>
  import { Mermaid } from '@friendofsvelte/mermaid';
  
  const invalidDiagram = `invalid syntax here`;
</script>

<Mermaid string={invalidDiagram}>
  {#snippet error(errorObj)}
    <div class="error-message">
      <p>Failed to render diagram: {errorObj.message}</p>
    </div>
  {/snippet}
</Mermaid>
```

## 发展

```bash
# Clone the repository
git clone https://github.com/friendofsvelte/mermaid.git
cd mermaid

# Install dependencies
npm install

# Start development server
npm run dev

# Run tests
npm run test

# Build library
npm run build
```

## 捐款

欢迎捐款! 请随意提交拉力请求.

1.  叉子存储器
2.  创建您的特性分支( E)`git checkout -b feature/amazing-feature`(中文(简体) )
3.  提交更改( E)`git commit -m 'Add some amazing feature'`(中文(简体) )
4.  推向分行(`git push origin feature/amazing-feature`(中文(简体) )
5.  打开拉请求

## 许可证

麻省理工学院 [斯维尔特的朋友](https://github.com/friendofsvelte)

## 链接

-   [文档](https://github.com/friendofsvelte/mermaid)
-   [实例](https://github.com/friendofsvelte/mermaid/tree/main/src/routes/test)
-   [问题](https://github.com/friendofsvelte/mermaid/issues)
-   [美人鱼.js 文档](https://mermaid.js.org/)
-   [丝绒](https://svelte.dev/)

* * *

由QQ为斯维尔特社区而建.

## 常见问题

### @friendofsvelte/mermaid 是什么？

Svelte 5具有强大的,型号安全的美人鱼\.js组件,具有SSS支持,自定义主题,以及响应性设计\.

### 如何安装 @friendofsvelte/mermaid？

在项目目录运行 npm install @friendofsvelte/mermaid，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：svelte（^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @friendofsvelte/mermaid 支持 TypeScript 吗？

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

### @friendofsvelte/mermaid 支持 ESM 还是 CommonJS？

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

### @friendofsvelte/mermaid 可以商用吗？

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

### @friendofsvelte/mermaid 的下载量有多少？

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

### @friendofsvelte/mermaid 还在维护吗？

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