@github/quote-selection

中文文档
2.2.0发布于 2025/10/07MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 1.3万

Add selected text to a text area as a markdown quote.

原始使用文档
文档目录5 节
  1. Installation
  2. Usage
  3. Preserving Markdown syntax
  4. Development
  5. License

Quote selection

Helpers for quoting selected text, appending the text into a <textarea> as a Markdown quote.

Installation

$ npm install @github/quote-selection

Usage

<div class="my-quote-region">
  <p>Text to quote</p>
  <textarea></textarea>
</div>
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 will take the currently selected HTML from the specified quote region, convert it to markdown, and create a quoted representation of the selection.

insert will insert the string representation of a selected text into the specified text area field.

Preserving Markdown syntax

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

Using MarkdownQuote instead of Quote will ensure markdown syntax is preserved.

The optional scopeSelector parameter of MarkdownQuote ensures that even if the user selection bleeds outside of the scoped element, the quoted portion will always be contained inside the scope. This is useful to avoid accidentally quoting parts of the UI that might be interspersed between quotable content.

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.

版本与发布记录

@github/quote-selection 共发布 29 个版本,首次发布于 2018/07/12;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.2.0latest2025/10/071.1 年前
2.1.02024/06/052 年前
2.0.02023/11/013 年前
1.0.22021/11/254 年前
1.0.12021/11/184 年前
1.0.02021/11/125 年前

关于 @github/quote-selection 的常见问题

@github/quote-selection 是什么?

Add selected text to a text area as a markdown quote.

如何安装 @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 和提交记录判断。