@ckeditor/ckeditor5-autoformat

Creates a listener triggered on event in the document. Calls the callback when inserted text matches the regular expression or the command name if provided instead of the callback.

Examples of usage:

To convert a paragraph into heading 1 when - is typed, using just the command name:

blockAutoformatEditing( editor, plugin, /^\- $/, 'heading1' );

To convert a paragraph into heading 1 when - is typed, using just the callback:

blockAutoformatEditing( editor, plugin, /^\- $/, ( context ) => {
	const { match } = context;
	const headingLevel = match[ 1 ].length;

	editor.execute( 'heading', {
		formatId: `heading${ headingLevel }`
	} );
} );

Parameter editor

The editor instance.

Parameter plugin

The autoformat plugin instance.

Parameter pattern

The regular expression to execute on just inserted text. The regular expression is tested against the text from the beginning until the caret position.

Parameter callbackOrCommand

The callback to execute or the command to run when the text is matched. In case of providing the callback, it receives the following parameter: * match RegExp.exec() result of matching the pattern to inserted text.

Enables autoformatting mechanism for a given .

It formats the matched text by applying the given model attribute or by running the provided formatting callback. On every in the model document the autoformatting engine checks the text on the left of the selection and executes the provided action if the text matches given criteria (regular expression or callback).

Parameter editor

The editor instance.

Parameter plugin

The autoformat plugin instance.

Parameter testRegexpOrCallback

The regular expression or callback to execute on text. Provided regular expression *must* have three capture groups. The first and the third capture group should match opening and closing delimiters. The second capture group should match the text to format.

// Matches the `**bold text**` pattern.
// There are three capturing groups:
// - The first to match the starting `**` delimiter.
// - The second to match the text to format.
// - The third to match the ending `**` delimiter.
inlineAutoformatEditing( editor, plugin, /(\*\*)([^\*]+?)(\*\*)$/g, formatCallback );

When a function is provided instead of the regular expression, it will be executed with the text to match as a parameter. The function should return proper "ranges" to delete and format.

{
	remove: [
		[ 0, 1 ],	// Remove the first letter from the given text.
		[ 5, 6 ]	// Remove the 6th letter from the given text.
	],
	format: [
		[ 1, 5 ]	// Format all letters from 2nd to 5th.
	]
}

Parameter formatCallback

A callback to apply actual formatting. It should return false if changes should not be applied (e.g. if a command is disabled).

inlineAutoformatEditing( editor, plugin, /(\*\*)([^\*]+?)(\*\*)$/g, ( writer, rangesToFormat ) => {
	const command = editor.commands.get( 'bold' );

	if ( !command.isEnabled ) {
		return false;
	}

	const validRanges = editor.model.schema.getValidRanges( rangesToFormat, 'bold' );

	for ( let range of validRanges ) {
		writer.setAttribute( 'bold', true, range );
	}
} );