Class TextEditor

A collection of helper functions and utility methods related to the rich text editor

Properties

`Static` `Private` #decoder

#decoder: HTMLTextAreaElement = ...

A singleton text area used for HTML decoding.

`Static` `Private` _PARAGRAPH_ELEMENTS

_PARAGRAPH_ELEMENTS: Set<string> = ...

A list of elements that are retained when truncating HTML.

Methods

`Static` create

create(options?, content?): Promise<any>
Create a Rich Text Editor. The current implementation uses TinyMCE
Parameters
- options: {
  engine: string;
  } = {}
  Configuration options provided to the Editor init
  - engine: string
    Which rich text editor engine to use, "tinymce" or "prosemirror". TinyMCE is deprecated and will be removed in a later version.
- content: string = ""
  Initial HTML or text content to populate the editor with
Returns Promise<any>
The editor instance.

`Static` decodeHTML

decodeHTML(html): string
Safely decode an HTML string, removing invalid tags and converting entities back to unicode characters.
Parameters
- html: string
  The original encoded HTML string
Returns string
The decoded unicode string

`Static` enrichHTML

enrichHTML(content, options?): Promise<string>
Enrich HTML content by replacing or augmenting components of it
Parameters
- content: string
  The original HTML content (as a string)
- Optional options: EnrichmentOptions = {}
  Additional options which configure how HTML is enriched
Returns Promise<string>
The enriched HTML content

`Static` previewHTML

previewHTML(content, length?): string
Preview an HTML fragment by constructing a substring of a given length from its inner text.
Parameters
- content: string
  The raw HTML to preview
- length: number = 250
  The desired length
Returns string
The previewed HTML

`Static` truncateHTML

truncateHTML(html): HTMLElement
Sanitises an HTML fragment and removes any non-paragraph-style text.
Parameters
- html: HTMLElement
  The root HTML element.
Returns HTMLElement

`Static` truncateText

truncateText(text, options?): string
Truncate a fragment of text to a maximum number of characters.
Parameters
- text: string
  The original text fragment that should be truncated to a maximum length
- Optional options: {
      maxLength: number;
      splitWords: boolean;
      suffix: string;
  } = {}
  Options which affect the behavior of text truncation
  - maxLength: number
    The maximum allowed length of the truncated string.
  - splitWords: boolean
    Whether to truncate by splitting on white space (if true) or breaking words.
  - suffix: string
    A suffix string to append to denote that the text was truncated.
Returns string
The truncated text string

`Static` createAnchor

createAnchor(options?): HTMLAnchorElement
Helper method to create an anchor element.
Parameters
- Optional options: object = {}
  Options to configure the anchor's construction.
Returns HTMLAnchorElement

`Static` activateListeners

activateListeners(): void
Activate interaction listeners for the interior content of the editor frame.

Returns void

`Static` getDragEventData

getDragEventData(event): object
Extract JSON data from a drag/drop event.
Parameters
- event: DragEvent
  The drag event which contains JSON data.
Returns object
The extracted JSON data. The object will be empty if the DragEvent did not contain JSON-parseable data.

`Static` getContentLink

getContentLink(eventData, options?): Promise<string>
Given a Drop event, returns a Content link if possible such as @Actor[ABC123], else null
Parameters
- eventData: object
  The parsed object of data provided by the transfer event
- Optional options: {
  relativeTo: ClientDocument;
  label: string;
  } = {}
  Additional options to configure link creation.
  - relativeTo: ClientDocument
    A document to generate the link relative to.
  - label: string
    A custom label to use instead of the document's name.
Returns Promise<string>

`Static` _uploadImage

_uploadImage(uuid, file): Promise<string>
Internal
Upload an image to a document's asset path.
Parameters
- uuid: string
  The document's UUID.
- file: File
  The image file to upload.
Returns Promise<string>
The path to the uploaded image.

`Static` `Protected` _createTinyMCE

_createTinyMCE(options?, content?): Promise<Editor>
Protected
Create a TinyMCE editor instance.
Parameters
- Optional options: object = {}
  Configuration options passed to the editor.
- Optional content: string = ""
  Initial HTML or text content to populate the editor with.
Returns Promise<Editor>
The TinyMCE editor instance.

`Static` `Protected` _primeCompendiums

_primeCompendiums(text): Promise<void>
Protected
Scan for compendium UUIDs and retrieve Documents in batches so that they are in cache when enrichment proceeds.
Parameters
- text: Text[]
  The text nodes to scan.
Returns Promise<void>

`Static` `Protected` _enrichContentLinks

_enrichContentLinks(text, options?): Promise<boolean>
Protected
Convert text of the form @UUID[uuid]{name} to anchor elements.
Parameters
- text: Text[]
  The existing text content
- Optional options: EnrichmentOptions = {}
  Options provided to customize text enrichment
Returns Promise<boolean>
Whether any content links were replaced and the text nodes need to be updated.

`Static` `Protected` _enrichEmbeds

_enrichEmbeds(text, options?): Promise<boolean>
Protected
Handle embedding Document content with @Embed[uuid]{label} text.
Parameters
- text: Text[]
  The existing text content.
- Optional options: EnrichmentOptions = {}
  Options provided to customize text enrichment.
Returns Promise<boolean>
Whether any embeds were replaced and the text nodes need to be updated.

`Static` `Protected` _enrichHyperlinks

_enrichHyperlinks(text, options?): Promise<boolean>
Protected
Convert URLs into anchor elements.
Parameters
- text: Text[]
  The existing text content
- Optional options: EnrichmentOptions = {}
  Options provided to customize text enrichment
Returns Promise<boolean>
Whether any hyperlinks were replaced and the text nodes need to be updated

`Static` `Protected` _enrichInlineRolls

_enrichInlineRolls(rollData, text): Promise<boolean>
Protected
Convert text of the form [[roll]] to anchor elements.
Parameters
- rollData: object | Function
  The data object providing context for inline rolls.
- text: Text[]
  The existing text content.
Returns Promise<boolean>
Whether any inline rolls were replaced and the text nodes need to be updated.

`Static` `Protected` _applyCustomEnrichers

_applyCustomEnrichers(config, text, options?): Promise<boolean>
Protected
Match any custom registered regex patterns and apply their replacements.
Parameters
- config: TextEditorEnricherConfig
  The custom enricher configuration.
- text: Text[]
  The existing text content.
- Optional options: EnrichmentOptions
  Options provided to customize text enrichment
Returns Promise<boolean>
Whether any replacements were made, requiring the text nodes to be updated.

`Static` `Protected` _createContentLink

_createContentLink(match, options?): Promise<HTMLAnchorElement>
Protected
Create a dynamic document link from a regular expression match
Parameters
- match: RegExpMatchArray
  The regular expression match
- Optional options: {
  relativeTo: Document;
  } = {}
  Additional options to configure enrichment behaviour
  - relativeTo: Document
    A document to resolve relative UUIDs against.
Returns Promise<HTMLAnchorElement>
An HTML element for the document link.

`Static` `Protected` _embedContent

_embedContent(match, options?): Promise<HTMLElement>
Protected
Embed content from another Document.
Parameters
- match: RegExpMatchArray
  The regular expression match.
- Optional options: EnrichmentOptions = {}
  Options provided to customize text enrichment.
Returns Promise<HTMLElement>
A representation of the Document as HTML content, or null if the Document could not be embedded.

`Static` `Protected` _parseEmbedConfig

_parseEmbedConfig(raw, options?): Record<string, string | number | boolean>
Protected
Parse the embed configuration to be passed to ClientDocument#toEmbed. The return value will be an object of any key=value pairs included with the configuration, as well as a separate values property that contains all the options supplied that were not in key=value format. If a uuid key is supplied it is used as the Document's UUID, otherwise the first supplied UUID is used.
Parameters
- raw: string
  The raw matched config string.
- Optional options: object = {}
  Options forwarded to parseUuid.
Returns Record<string, string | number | boolean>
Example: Example configurations.
```
TextEditor._parseEmbedConfig('uuid=Actor.xyz caption="Example Caption" cite=false');
// Returns: { uuid: "Actor.xyz", caption: "Example Caption", cite: false, values: [] }

TextEditor._parseEmbedConfig('Actor.xyz caption="Example Caption" inline');
// Returns: { uuid: "Actor.xyz", caption: "Example Caption", values: ["inline"] }
```

`Static` `Protected` _createInlineRoll

_createInlineRoll(match, rollData): Promise<HTMLAnchorElement>
Protected
Replace an inline roll formula with a rollable <a> element or an eagerly evaluated roll result
Parameters
- match: RegExpMatchArray
  The regular expression match array
- rollData: object
  Provided roll data for use in roll evaluation
Returns Promise<HTMLAnchorElement>
The replaced match. Returns null if the contained command is not a valid roll expression.

`Static` `Protected` _onClickEmbeddedAction

_onClickEmbeddedAction(event): Promise<void>
Protected
Handle actions in embedded content.
Parameters
- event: PointerEvent
  The originating event.
Returns Promise<void>

`Static` `Private` _getTextNodes

_getTextNodes(parent): Text[]
Private
Recursively identify the text nodes within a parent HTML node for potential content replacement.
Parameters
- parent: HTMLElement
  The parent HTML Element
Returns Text[]
An array of contained Text nodes

`Static` `Private` _replaceTextContent

_replaceTextContent(text, rgx, func, options?): boolean
Private
Facilitate the replacement of text node content using a matching regex rule and a provided replacement function.
Parameters
- text: Text[]
  The text nodes to match and replace.
- rgx: RegExp
  The provided regular expression for matching and replacement
- func: TextContentReplacer
  The replacement function
- Optional options: TextReplacementOptions = {}
  Options to configure text replacement behavior.
Returns boolean
Whether a replacement was made.

`Static` `Private` _replaceTextNode

_replaceTextNode(text, match, replacement, options?): void
Private
Replace a matched portion of a Text node with a replacement Node
Parameters
- text: Text
  The Text node containing the match.
- match: RegExpMatchArray
  The regular expression match.
- replacement: Node
  The replacement Node.
- Optional options: TextReplacementOptions = {}
  Options to configure text replacement behavior.
Returns void

`Static` `Private` _createLegacyContentLink

_createLegacyContentLink(type, target, name, data): boolean
Private
Create a dynamic document link from an old-form document link expression.
Parameters
- type: string
  The matched document type, or "Compendium".
- target: string
  The requested match target (_id or name).
- name: string
  A customized or overridden display name for the link.
- data: object
  Data containing the properties of the resulting link element.
Returns boolean
Whether the resulting link is broken or not.

`Static` `Private` _createHyperlink

_createHyperlink(match): Promise<HTMLAnchorElement>
Private
Replace a hyperlink-like string with an actual HTML <a> tag
Parameters
- match: RegExpMatchArray
  The regular expression match
Returns Promise<HTMLAnchorElement>
An HTML element for the document link

`Static` `Private` _onClickContentLink

_onClickContentLink(event): Promise<any>
Private
Handle click events on Document Links
Parameters
- event: Event
Returns Promise<any>

`Static` `Private` _onClickInlineRoll

_onClickInlineRoll(event): Promise<any>
Private
Handle left-mouse clicks on an inline roll, dispatching the formula or displaying the tooltip
Parameters
- event: MouseEvent
  The initiating click event
Returns Promise<any>

`Static` `Private` _onDragContentLink

_onDragContentLink(event): boolean
Private
Begin a Drag+Drop workflow for a dynamic content link
Parameters
- event: Event
  The originating drag event
Returns boolean

`Static` `Private` _onDropEditorData

_onDropEditorData(event, editor): Promise<void>
Private
Handle dropping of transferred data onto the active rich text editor
Parameters
- event: DragEvent
  The originating drop event which triggered the data transfer
- editor: TinyMCE
  The TinyMCE editor instance being dropped on
Returns Promise<void>

Class TextEditor

Index

Properties

Methods

Properties

Static Private #decoder

Static Private _PARAGRAPH_ELEMENTS

Methods

Static create

Parameters

engine: string

Returns Promise<any>

Static decodeHTML

Parameters

Returns string

Static enrichHTML

Parameters

Returns Promise<string>

Static previewHTML

Parameters

Returns string

Static truncateHTML

Parameters

Returns HTMLElement

Static truncateText

Parameters

maxLength: number

splitWords: boolean

suffix: string

Returns string

Static createAnchor

Parameters

Returns HTMLAnchorElement

Static activateListeners

Returns void

Static getDragEventData

Parameters

Returns object

Static getContentLink

Parameters

relativeTo: ClientDocument

label: string

Returns Promise<string>

Static _uploadImage

Parameters

Returns Promise<string>

Static Protected _createTinyMCE

Parameters

Returns Promise<Editor>

Static Protected _primeCompendiums

Parameters

Returns Promise<void>

Static Protected _enrichContentLinks

Parameters

Returns Promise<boolean>

Static Protected _enrichEmbeds

Parameters

Returns Promise<boolean>

Static Protected _enrichHyperlinks

Parameters

Returns Promise<boolean>

Static Protected _enrichInlineRolls

Parameters

Returns Promise<boolean>

Static Protected _applyCustomEnrichers

Parameters

Returns Promise<boolean>

Static Protected _createContentLink

Parameters

relativeTo: Document

Returns Promise<HTMLAnchorElement>

Static Protected _embedContent

Parameters

Returns Promise<HTMLElement>

Static Protected _parseEmbedConfig

Parameters

Returns Record<string, string | number | boolean>

Example: Example configurations.

Static Protected _createInlineRoll

Parameters

`Static` `Private` #decoder

`Static` `Private` _PARAGRAPH_ELEMENTS

`Static` create

`Static` decodeHTML

`Static` enrichHTML

`Static` previewHTML

`Static` truncateHTML

`Static` truncateText

`Static` createAnchor

`Static` activateListeners

`Static` getDragEventData

`Static` getContentLink

`Static` _uploadImage

`Static` `Protected` _createTinyMCE

`Static` `Protected` _primeCompendiums

`Static` `Protected` _enrichContentLinks

`Static` `Protected` _enrichEmbeds

`Static` `Protected` _enrichHyperlinks

`Static` `Protected` _enrichInlineRolls

`Static` `Protected` _applyCustomEnrichers

`Static` `Protected` _createContentLink

`Static` `Protected` _embedContent

`Static` `Protected` _parseEmbedConfig

`Static` `Protected` _createInlineRoll

`Static` `Protected` _onClickEmbeddedAction

`Static` `Private` _getTextNodes

`Static` `Private` _replaceTextContent

`Static` `Private` _replaceTextNode

`Static` `Private` _createLegacyContentLink

`Static` `Private` _createHyperlink

`Static` `Private` _onClickContentLink

`Static` `Private` _onClickInlineRoll

`Static` `Private` _onDragContentLink

`Static` `Private` _onDropEditorData