# @atcute/leaflet 中文文档

规范地址：https://npmcn.com/package/%40atcute/leaflet/

版本：2\.0\.21
npm 元数据更新时间：2026-10-21T16:24:25.684Z
中文译文更新时间：2026-11-07T01:54:03.603Z
软件包许可：0BSD

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

原始 npm 页面：https://www.npmjs.com/package/%40atcute/leaflet
原文对照：https://npmcn.com/package/%40atcute/leaflet/?lang=original
源码仓库：https://tangled.org/did:plc:pljn5qch4tgadongtc7i6qij

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

- 包体积（解压后）：153 kB，107 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：2 个
- peer 依赖：@atcute/lexicons ^2\.0\.0
- 首次发布：2025-05-26T01:47:36.977Z
- 最新版本发布：2026-10-21T16:24:25.488Z
- 近 30 天下载量：3445（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 34 个）

## 中文简介

Leaflet (pub.leaflet.\*) 计划定义

## 安装

```sh
npm install @atcute/leaflet
```

也可以使用：`pnpm add @atcute/leaflet`、`yarn add @atcute/leaflet`、`bun add @atcute/leaflet`

## README

# @ tcute/ 叶片

[传单](https://leaflet.pub/) (pub.leaflet.\*) 计划定义

```sh
npm install @atcute/leaflet
```

## 使用量

```ts
import { PubLeafletDocument } from '@atcute/leaflet';
import { is } from '@atcute/lexicons';

const document: PubLeafletDocument.Main = {
    $type: 'pub.leaflet.document',
    title: 'Article title',
    author: 'did:plc:ia76kvnndjutgedggx2ibrem',
    description: 'Article description',
    publication: 'at://did:plc:ia76kvnndjutgedggx2ibrem/pub.leaflet.publication/3lpyvgcwc722m',
    publishedAt: '2025-05-25T14:44:37.870Z',
    pages: [
        {
            $type: 'pub.leaflet.pages.linearDocument',
            blocks: [
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [{ index: { byteEnd: 12, byteStart: 0 }, features: [] }],
                        plaintext: 'Hello world!',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [
                            {
                                index: { byteEnd: 9, byteStart: 0 },
                                features: [{ $type: 'pub.leaflet.richtext.facet#bold' }],
                            },
                        ],
                        plaintext: 'Bold text',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [
                            {
                                index: { byteEnd: 11, byteStart: 0 },
                                features: [{ $type: 'pub.leaflet.richtext.facet#italic' }],
                            },
                        ],
                        plaintext: 'Italic text',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [
                            {
                                index: { byteEnd: 16, byteStart: 0 },
                                features: [
                                    { $type: 'pub.leaflet.richtext.facet#bold' },
                                    { $type: 'pub.leaflet.richtext.facet#italic' },
                                ],
                            },
                        ],
                        plaintext: 'Bold italic text',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: { $type: 'pub.leaflet.blocks.text', facets: [], plaintext: '' },
                },
            ],
        },
    ],
};

is(PubLeafletDocument.mainSchema, document);
// -> true
```

### 与 `@atcute/client`

选择这3个选项之一来登记环境声明

```jsonc
// tsconfig.json
{
    "compilerOptions": {
        "types": ["@atcute/leaflet"],
    },
}
```

```ts
// env.d.ts
/// <reference types="@atcute/leaflet" />
```

```ts
// index.ts
import type {} from '@atcute/leaflet';
```

现在所有 XRPC 操作都应该在客户端可见

### 与 `@atcute/lex-cli`

创建您自己引用 Leaflet 类型的词典时, 请配置 lex- cli 从此导入 软件包 :

```ts
// file: lex.config.js
import { defineLexiconConfig } from '@atcute/lex-cli';

export default defineLexiconConfig({
    files: ['lexicons/**/*.json'],
    outdir: 'src/lexicons/',
    imports: ['@atcute/leaflet'],
});
```

## 常见问题

### @atcute/leaflet 是什么？

Leaflet \(pub\.leaflet\.\*\) 计划定义

### 如何安装 @atcute/leaflet？

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

### @atcute/leaflet 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/atcute\_\_leaflet 是否存在。

### @atcute/leaflet 支持 ESM 还是 CommonJS？

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

### @atcute/leaflet 可以商用吗？

@atcute/leaflet 使用 0BSD 许可。几乎没有限制：可自由使用、修改和分发，连保留版权声明也不要求。以上为概括，不构成法律意见，请以许可原文为准。

### @atcute/leaflet 的下载量有多少？

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

### @atcute/leaflet 还在维护吗？

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