Writers

Invox Dictation must know how to perform write operations on an editor or any target element.

Writer Schema

The Writer or TextWriter is responsible for performing the basic operations in a text editor. It works as a proxy that references the editor instance and allows Invox Dictation to type the recognized text, move through the text using voice commands, select words or entire lines, delete text, redo, undo, etc.

Available TextWriters

EditorTextWriter to use
TextAreaINVOX.TextAreaTextWriter
Other editorsCustom implementation required

If you use another type of editor, you must implement your own TextWriter.

The TextWriter is the entity that knows how the basic write/read operations work in a given editor, because each type of editor implements its own API. For example, writing in a CKEditor V4 editor is different from writing in a TinyMCE editor.

Asynchronous Editors

Invox Dictation can adapt to the asynchronicity of a text editor based on the type of Writer implementation.

  • If the writer's basic operations are synchronous, Invox Dictation will perform writing operations synchronously.
  • If the writer uses asynchronous techniques (Promises or Async/Await), the API will follow the same behavior.

Asynchronous text editors use techniques like AJAX to save changes to the server. Examples include CKEditor, TinyMCE, Quill, and Froala Editor.

Getting started

See the Quick Start guide to implement your own TextWriter step by step.

Table of Contents