editor object is available in all action scripts. This object allows manipulation of the main editing window in Drafts, altering the text, text selections, or loading a different draft into the editor, etc.
Typically scripting actions that work like custom keyboard commands and similar will utilize the editor functions to manipulate text.
NOTE: Generally speaking, editor methods are best used for quick text manipulations of the type used in the extended keyboard. Most substantial updates to draft content are better applied using the
// get the currently selected text
let text = editor.getSelectedText()
// replace selected text with uppercased version
Is editor current focused for editing.
Access or set current link mode status.
Access or set current pinning status for editor.
Returns the current tab string is use. This could be 2 spaces, 4 spaces, or
\t depending on the editor preferences for the current syntax. Useful in actions, such as indent/outdent actions, which need to insert or remove indentation and want to match the options of the current syntax.
Access or set current typewriter scrolling status.
Convenience method to return the linked items in the text, as located by the syntax definitions'
linkDefinitions. In Markdown syntaxes, these map to
Array of navigation markers in the text. Navigation markers are defined by the syntax definition in use in the editor, and are used in the Navigation feature.
Array of recent drafts. This is the same list as used in the navigation features of the editor, and is in reverse order, so that the first index in the array is the previous draft loaded in the editor.
Convenience method to scan the text for valid URLs, and return all found URLs as an array. This will return valid full URL strings - both for
http(s) and custom URLs found in the text.
Request focus for the editor. This will dismiss other views and show the keyboard on the currently loaded draft. Useful if an action opens user interface elements or otherwise causes the editor to resign focus and you would like to return to editing at the end of the action's execution.
Opens the arrange mode view with the passed text for arranging. Returns the arranged text if the user makes changes and taps "Done", the original text if the user cancels.
String containing result of arrange. If user cancels, it will be the same as the original text passed.
The text to arrange
Resign focus for the editor. If the editor text view is currently focused for editing (e.g. showing keyboard), resign focus.
Open dictation interface, and return the result as a string. The string will be empty if user cancels.
The accepted dictation text.
the preferred locale can be passed in the format "en-US" (U.S. English), "it-IT" (Italian-Italian), "es-MX" (Mexican Spanish), etc.
Loads an existing draft into the editor.
Creates a new blank draft and loads it into the editor.
Apply redo action to editor, if one is available.
Save any current changes to the draft.
Open document scanning camera to scan documents and OCR, returning the result as a string. The string will be empty if user cancels, or document scanning is not available.
The text recognized in the OCR of the scanned document.
Open arrange mode in editor. This is a non-blocking method and returns immediately. It is intended only to mimic the tapping of the arrange button. Use
editor.arrange(text) to wait for a result.
Open dictation mode in editor. This is a non-blocking method and returns immediately. It is intended only to mimic the tapping of the dictate button. Use
editor.dictate() to wait for a result and use it in further scripting.
Open find mode in editor.
If true, skip native find implementation and option Drafts advanced find directly.
Open Opens audio transcription window. If file is selected and transcribed, returns text.
The text recognized in the audio transcription.
Apply undo action to editor, if one is available.
Expand the range provided to the nearest beginning and end of the lines it encompasses.
Get the current selected text range extended to the beginning and end of the lines it encompasses.
Get text range that was last selected.
Get text range that was last selected.
Get the full text currently loaded in the editor.
Get the substring in a range from the text in the editor.
The next navigation marker in the editor, relative to the character location. This is a convenience method to assist in navigating by marker.
The previous navigation marker in the editor, relative to the character location. This is a convenience method to assist in navigating by marker.
Update the text selection in the editor by passing the start location and the length of the new selection.
Replace the contents of the last text selection with a string.
Replace the contents of the editor with a string.
Replace the text in the passed range with new text.
Generated using TypeDoc