@ckeditor/ckeditor5-block-quote
- Version 39.0.2
- Published
- 112 kB
- 1 dependency
- GPL-2.0-or-later license
Install
npm i @ckeditor/ckeditor5-block-quote
yarn add @ckeditor/ckeditor5-block-quote
pnpm add @ckeditor/ckeditor5-block-quote
Overview
Block quote feature for CKEditor 5.
Index
Classes
class BlockQuote
class BlockQuote extends Plugin {}
The block quote plugin.
For more information about this feature check the .
This is a "glue" plugin which loads the and .
module:core/plugin~Plugin
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: readonly [ typeof BlockQuoteEditing, typeof BlockQuoteUI];
class BlockQuoteCommand
class BlockQuoteCommand extends Command {}
The block quote command plugin.
module:core/command~Command
property value
value: boolean;
Whether the selection starts in a block quote.
Modifiers
@readonly
method execute
execute: (options?: { forceValue?: boolean }) => void;
Executes the command. When the command , all top-most block quotes within the selection will be removed. If it is off, all selected blocks will be wrapped with a block quote.
execute
Parameter options
Command options.
Parameter
options.forceValue If set, it will force the command behavior. If
true
, the command will apply a block quote, otherwise the command will remove the block quote. If not set, the command will act basing on its current value.
method refresh
refresh: () => void;
class BlockQuoteEditing
class BlockQuoteEditing extends Plugin {}
The block quote editing.
Introduces the
'blockQuote'
command and the'blockQuote'
model element.module:core/plugin~Plugin
property pluginName
static readonly pluginName: string;
property requires
static readonly requires: readonly [any, any];
method init
init: () => void;
class BlockQuoteUI
class BlockQuoteUI extends Plugin {}
The block quote UI plugin.
It introduces the
'blockQuote'
button.module:core/plugin~Plugin
property pluginName
static readonly pluginName: string;
method init
init: () => void;
Package Files (5)
Dependencies (1)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@ckeditor/ckeditor5-block-quote
.
- Markdown[](https://www.jsdocs.io/package/@ckeditor/ckeditor5-block-quote)
- HTML<a href="https://www.jsdocs.io/package/@ckeditor/ckeditor5-block-quote"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2771 ms. - Missing or incorrect documentation? Open an issue for this package.