@github/quote-selection
v2.1.0
Published
Add selected text to a text area as a markdown quote.
Downloads
1,676
Maintainers
Keywords
Readme
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.