quote-selection 1.0.2
Install from the command line:
Learn more about npm packages
$ npm install @github/quote-selection@1.0.2
Install via package.json:
"@github/quote-selection": "1.0.2"
About this version
Helpers for quoting selected text, appending the text into a <textarea>
as a Markdown quote.
$ npm install @github/quote-selection
<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.
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.
npm install
npm test
Distributed under the MIT license. See LICENSE for details.