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

245 lines
4.0 KiB
Markdown
Raw Normal View History

2021-11-03 19:58:08 +08:00
# Change
Operations related to editor changes
Type: `ChangeInterface`
## Use
```ts
new Engine(...).change
```
## Constructor
```ts
new (container: NodeInterface, options: ChangeOptions): ChangeInterface;
```
## Attributes
### `rangePathBeforeCommand`
Path after cursor conversion before command execution
```ts
rangePathBeforeCommand: Path[] | null;
```
### `event`
event
```ts
event: ChangeEventInterface;
```
2021-11-08 20:09:23 +08:00
### `range`
Range of the change
```ts
range: ChangeRangeInterface;
```
2021-11-03 19:58:08 +08:00
### `marks`
All style nodes in the current cursor selection
```ts
marks: Array<NodeInterface>;
```
### `blocks`
All block-level nodes in the current cursor selection
```ts
blocks: Array<NodeInterface>;
```
### `inlines`
All inline nodes in the current cursor selection
```ts
inlines: Array<NodeInterface>;
```
## Method
### `apply`
Apply an operation that changes the dom structure
```ts
/**
* 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
```ts
combinText(): void;
```
### `isComposing`
Is it in the combined input
```ts
isComposing(): boolean;
```
### `isSelecting`
Is it being selected
```ts
isSelecting(): boolean;
```
### `setValue`
Set editor value
```ts
/**
* @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
```ts
/**
* 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
```ts
getOriginValue(): string;
```
### `getValue`
Get editor value
```ts
/**
* @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
```ts
cacheRangeBeforeCommand(): void;
```
### `getRangePathBeforeCommand`
Get the path after the cursor conversion before the command is executed
```ts
getRangePathBeforeCommand(): Path[] | null;
```
### `isEmpty`
Whether the current editor is empty
```ts
isEmpty(): boolean;
```
### `destroy`
destroy
```ts
destroy(): void;
```
### `insert`
2021-11-08 20:09:23 +08:00
Insert Fragment
2021-11-03 19:58:08 +08:00
```ts
/**
2021-11-08 20:09:23 +08:00
* 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;
2021-11-03 19:58:08 +08:00
```
### `delete`
Delete content
```ts
/**
2021-11-08 20:09:23 +08:00
* 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;
2021-11-03 19:58:08 +08:00
```
### `unwrap`
Remove the block node closest to the current cursor or the outer package of the incoming node
```ts
/**
* 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
```ts
/**
* 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;
```