# @github/quote-selection 中文文档

规范地址：https://npmcn.com/package/%40github/quote-selection/

版本：2\.2\.0
npm 元数据更新时间：2026-10-15T16:20:58.119Z
中文译文更新时间：2026-11-16T11:08:17.457Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：3.8 kB，3 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2018-07-11T23:49:31.021Z
- 最新版本发布：2025-10-07T14:08:15.107Z
- 近 30 天下载量：13397（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 0 个）

## 中文简介

将所选文本添加到文本区域作为下标引号.

## 安装

```sh
npm install @github/quote-selection
```

也可以使用：`pnpm add @github/quote-selection`、`yarn add @github/quote-selection`、`bun add @github/quote-selection`

## README

# 引用选择

引用所选文本的助手,将文本附加到 `<textarea>` 作为Markdown的引言.

## 安装

```
$ npm install @github/quote-selection
```

## 使用量

```html
<div class="my-quote-region">
  <p>Text to quote</p>
  <textarea></textarea>
</div>
```

```js
import {Quote} from '@github/quote-selection'

document.addEventListener('keydown', event => {
  if (event.key == 'r') {
    const quote = new Quote()
    if (quote.closest('.my-quote-region')) {
      quote.insert(document.querySelector('textarea'))
    }
  }
})
```

`Quote` 将选择当前从指定的引号区域中选择的 HTML,将其转换为下标,并创建一个引用的表示选择.

`insert` 将选定文本的字符串表达式插入到指定的文本区域.

### 保留马克下语法

```js
const quote = new MarkdownQuote('.comment-body')
quote.select(document.querySelector('.comment-body'))
if (quote.closest('.my-quote-region')) {
  quote.insert(quote, document.querySelector('textarea'))
}
```

使用 `MarkdownQuote` 改为 `Quote` 将保证标记下语法得到保存.

可选 `scopeSelector` 参数 `MarkdownQuote` 确保即使用户选择在范围要素外出出出血,引用的部分将始终被包含在范围之内。 这样做有助于避免不慎引用UI中可能介于可配额内容之间的部分.

## 发展

```
npm install
npm test
```

## 许可证

以麻省理工学院许可证分发。 详情见LICENSE.

## 常见问题

### @github/quote-selection 是什么？

将所选文本添加到文本区域作为下标引号\.

### 如何安装 @github/quote-selection？

在项目目录运行 npm install @github/quote-selection，或使用 pnpm add / yarn add / bun add。

### @github/quote-selection 支持 TypeScript 吗？

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

### @github/quote-selection 支持 ESM 还是 CommonJS？

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

### @github/quote-selection 可以商用吗？

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

### @github/quote-selection 的下载量有多少？

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

### @github/quote-selection 还在维护吗？

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

