@ckeditor/ckeditor5-autoformat/dist/autoformat.d.ts

Autoformatting feature for CKEditor 5.

/**
 * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
 */
import { Plugin } from '@ckeditor/ckeditor5-core';
import { Delete } from '@ckeditor/ckeditor5-typing';
/**
 * Enables a set of predefined autoformatting actions.
 *
 * For a detailed overview, check the {@glink features/autoformat Autoformatting} feature guide
 * and the {@glink api/autoformat package page}.
 */
export declare class Autoformat extends Plugin {
    /**
     * @inheritDoc
     */
    static get requires(): readonly [typeof Delete];
    /**
     * @inheritDoc
     */
    static get pluginName(): "Autoformat";
    /**
     * @inheritDoc
     */
    static get isOfficialPlugin(): true;
    /**
     * @inheritDoc
     */
    afterInit(): void;
    /**
     * Adds autoformatting related to the {@link module:list/list~List}.
     *
     * When typed:
     * - `* ` or `- ` – A paragraph will be changed into a bulleted list.
     * - `1. ` or `1) ` – A paragraph will be changed into a numbered list ("1" can be any digit or a list of digits).
     * - `[] ` or `[ ] ` – A paragraph will be changed into a to-do list.
     * - `[x] ` or `[ x ] ` – A paragraph will be changed into a checked to-do list.
     */
    private _addListAutoformats;
    /**
     * Adds autoformatting related to the {@link module:basic-styles/bold~Bold},
     * {@link module:basic-styles/italic~Italic}, {@link module:basic-styles/code~Code}
     * and {@link module:basic-styles/strikethrough~Strikethrough}
     *
     * When typed:
     * - `**foobar**` – `**` characters are removed and `foobar` is set to bold,
     * - `__foobar__` – `__` characters are removed and `foobar` is set to bold,
     * - `*foobar*` – `*` characters are removed and `foobar` is set to italic,
     * - `_foobar_` – `_` characters are removed and `foobar` is set to italic,
     * - ``` `foobar` – ``` ` ``` characters are removed and `foobar` is set to code,
     * - `~~foobar~~` – `~~` characters are removed and `foobar` is set to strikethrough.
     */
    private _addBasicStylesAutoformats;
    /**
     * Adds autoformatting related to {@link module:heading/heading~Heading}.
     *
     * It is using a number at the end of the command name to associate it with the proper trigger:
     *
     * * `heading` with a `heading1` value will be executed when typing `#`,
     * * `heading` with a `heading2` value will be executed when typing `##`,
     * * ... up to `heading6` for `######`.
     */
    private _addHeadingAutoformats;
    /**
     * Adds autoformatting related to {@link module:block-quote/blockquote~BlockQuote}.
     *
     * When typed:
     * * `> ` – A paragraph will be changed to a block quote.
     */
    private _addBlockQuoteAutoformats;
    /**
     * Adds autoformatting related to {@link module:code-block/codeblock~CodeBlock}.
     *
     * When typed:
     * - `` ``` `` – A paragraph will be changed to a code block.
     */
    private _addCodeBlockAutoformats;
    /**
     * Adds autoformatting related to {@link module:horizontal-line/horizontalline~HorizontalLine}.
     *
     * When typed:
     * - `` --- `` – Will be replaced with a horizontal line.
     */
    private _addHorizontalLineAutoformats;
}