/** * @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 */ /** * @module engine/model/utils/insertcontent */ import { ModelDocumentSelection } from "../documentselection.js"; import { ModelRange } from "../range.js"; import { type ModelDocumentFragment } from "../documentfragment.js"; import { type ModelItem } from "../item.js"; import { type Model } from "../model.js"; import { type ModelSelection } from "../selection.js"; /** * Inserts content into the editor (specified selection) as one would expect the paste functionality to work. * * It takes care of removing the selected content, splitting elements (if needed), inserting elements and merging elements appropriately. * * Some examples: * * ```html *
x^
+y
=>x
y
=>xy[]
*x^y
+z
=>x
^y
+z
=>x
z
y
=>xz[]y
*x^y
+x
^y
+x
y
*x
^
z
+y
=>x
y[]
z
(no merging) *x
[z
+y
=>x
^z
+y
=>x
y[]
z
* ``` * * If an instance of {@link module:engine/model/selection~ModelSelection} is passed as `selectable` it will be modified * to the insertion selection (equal to a range to be selected after insertion). * * If `selectable` is not passed, the content will be inserted using the current selection of the model document. * * **Note:** Use {@link module:engine/model/model~Model#insertContent} instead of this function. * This function is only exposed to be reusable in algorithms which change the {@link module:engine/model/model~Model#insertContent} * method's behavior. * * @param model The model in context of which the insertion should be performed. * @param content The content to insert. * @param selectable Selection into which the content should be inserted. * @returns Range which contains all the performed changes. This is a range that, if removed, * would return the model to the state before the insertion. If no changes were preformed by `insertContent`, returns a range collapsed * at the insertion position. * @internal */ export declare function insertContent(model: Model, content: ModelItem | ModelDocumentFragment, selectable?: ModelSelection | ModelDocumentSelection): ModelRange;