am-editor-001/docs/api/editor-change.md

Change

Operations related to editor changes

Type: ChangeInterface

Use

new Engine(...).change

Constructor

new (container: NodeInterface, options: ChangeOptions): ChangeInterface;

Attributes

rangePathBeforeCommand

Path after cursor conversion before command execution

rangePathBeforeCommand: Path[] | null;

event

event

event: ChangeEventInterface;

range

Range of the change

range: ChangeRangeInterface;

marks

All style nodes in the current cursor selection

marks: Array<NodeInterface>;

blocks

All block-level nodes in the current cursor selection

blocks: Array<NodeInterface>;

inlines

All inline nodes in the current cursor selection

inlines: Array<NodeInterface>;

Method

apply

Apply an operation that changes the dom structure

/**
 * Apply an operation that changes the dom structure
 * @param range cursor
 */
apply(range?: RangeInterface): void;

combinText

Combine the interrupted characters in the current editing into an uninterrupted character

combinText(): void;

isComposing

Is it in the combined input

isComposing(): boolean;

isSelecting

Is it being selected

isSelecting(): boolean;

setValue

Set editor value

/**
  * @param value
  * @param onParse uses root node parsing and filtering before converting to standard editor values
  * @param options Card asynchronous rendering callback
  * */
setValue(value: string, onParse?: (node: Node) => void, callback?: (count: number) => void): void;

setHtml

Set html as editor value

/**
  * Set html, it will be formatted as a legal editor value
  * @param html html
  * @param options Card asynchronous rendering callback
  */
setHtml(html: string, , callback?: (count: number) => void): void

getOriginValue

Get the original value of the editor

getOriginValue(): string;

getValue

Get editor value

/**
 * @param ignoreCursor Whether to fool the record node where the cursor is located
 * */
getValue(options: {ignoreCursor?: boolean }): string;

cacheRangeBeforeCommand

Cache the cursor object before executing the command

cacheRangeBeforeCommand(): void;

getRangePathBeforeCommand

Get the path after the cursor conversion before the command is executed

getRangePathBeforeCommand(): Path[] | null;

isEmpty

Whether the current editor is empty

isEmpty(): boolean;

destroy

destroy

destroy(): void;

insert

Insert Fragment

/**
  * Insert fragment
  * @param fragment fragment
  * @param range cursor position, default current cursor position
  * @param callback callback function after insertion
  * @param followActiveMark Whether the empty label follows the currently activated mark style after deletion
  */
insert(
fragment: DocumentFragment,
range?: RangeInterface,
callback?: (range: RangeInterface) => void,
followActiveMark?: boolean,
): void;

delete

Delete content

/**
* Delete content
* @param range cursor, get the current cursor by default
* @param isDeepMerge Whether to merge after deletion
* @param followActiveMark Whether the empty label follows the currently activated mark style after deletion
*/
delete(
range?: RangeInterface,
isDeepMerge?: boolean,
followActiveMark?: boolean,
): void;

unwrap

Remove the block node closest to the current cursor or the outer package of the incoming node

/**
 * Remove the block node closest to the current cursor or the outer package of the incoming node
 * @param node node
 */
unwrap(node?: NodeInterface): void;

mergeAfterDelete

Delete the block node closest to the current cursor or the previous node of the incoming node and merge it

/**
 * Delete the block node closest to the current cursor or the previous node of the incoming node and merge it
 * @param node node
 */
mergeAfterDelete(node?: NodeInterface): void;