OpenCloud
/
riot-web
mirror of https://github.com/vector-im/riot-web
1
0
Fork 0
Code Issues Releases Wiki Activity

improve editor model documentation

pull/21833/head
Bruno Windels 2019-08-26 16:10:02 +02:00
parent f8f0e77bde
commit 4fd4ad41c1
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/editor/model.js
View File

@ -19,6 +19,13 @@ import {diffAtCaret, diffDeletion} from "./diff";
import DocumentPosition from "./position"; import DocumentPosition from "./position";
import Range from "./range"; import Range from "./range";
/**
* @callback ModelCallback
* @param {DocumentPosition?} caretPosition the position where the caret should be position
* @param {string?} inputType the inputType of the DOM input event
* @param {object?} diff an object with `removed` and `added` strings
*/
/** /**
* @callback TransformCallback * @callback TransformCallback
* @param {DocumentPosition?} caretPosition the position where the caret should be position * @param {DocumentPosition?} caretPosition the position where the caret should be position
@ -50,6 +57,9 @@ export default class EditorModel {
this._transformCallback = transformCallback; this._transformCallback = transformCallback;
} }
/** Set a callback for rerendering the model after it has been updated.
* @param {ModelCallback} updateCallback
*/
setUpdateCallback(updateCallback) { setUpdateCallback(updateCallback) {
this._updateCallback = updateCallback; this._updateCallback = updateCallback;
} }
@ -376,6 +386,11 @@ export default class EditorModel {
return new DocumentPosition(index, totalOffset - currentOffset); return new DocumentPosition(index, totalOffset - currentOffset);
} }
/**
* Starts a range, which can span across multiple parts, to find and replace text.
* @param {DocumentPosition} position where to start the range
* @return {Range}
*/
startRange(position) { startRange(position) {
return new Range(this, position); return new Range(this, position);
} }