Class TextEditor

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

Accessors

`Static`implementation

get implementation(): typeof applications.ux.TextEditor
Retrieve the configured TextEditor implementation.

Returns typeof applications.ux.TextEditor

Methods

`Static`_uploadImage

_uploadImage(uuid: string, file: File): Promise<string | void>
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 | void>
The path to the uploaded image.

`Static`activateListeners

activateListeners(document: Document): void
Activate interaction listeners for the interior content of the editor frame.
Parameters
- document: Document
  The document to bind listeners to.
Returns void

`Static`create

create(options?: { engine?: string }, content?: string): ProseMirrorEditor
Create a Rich Text Editor. The current implementation uses ProseMirror.
Parameters
- options: { engine?: string } = {}
  Configuration options provided to the Editor init
  - Optionalengine?: string
    Which rich text editor engine to use.
- content: string = ""
  Initial HTML or text content to populate the editor with
Returns ProseMirrorEditor
The editor instance.

`Static`createAnchor

createAnchor(options?: Partial<EnrichmentAnchorOptions>): HTMLAnchorElement
Helper method to create an anchor element.
Parameters
- Optionaloptions: Partial<EnrichmentAnchorOptions> = {}
  Options to configure the anchor's construction.
Returns HTMLAnchorElement

`Static`decodeHTML

decodeHTML(html: string): 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: string, options?: EnrichmentOptions): Promise<string>
Enrich HTML content by replacing or augmenting components of it
Parameters
- content: string
  The original HTML content (as a string)
- Optionaloptions: EnrichmentOptions = {}
  Additional options which configure how HTML is enriched
Returns Promise<string>
The enriched HTML content

`Static`getContentLink

getContentLink(
eventData: object,
options?: { label?: string; relativeTo?: any },
): Promise<string | null>
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
- Optionaloptions: { label?: string; relativeTo?: any } = {}
  Additional options to configure link creation.
  - Optionallabel?: string
    A custom label to use instead of the document's name.
  - OptionalrelativeTo?: any
    A document to generate the link relative to.
Returns Promise<string | null>

`Static`getDragEventData

getDragEventData(event: DragEvent): 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`previewHTML

previewHTML(content: string, length?: number): 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): 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: string,
    options?: {
        maxLength?: number;
        splitWords?: boolean;
        suffix?: string | null;
    },
): 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
- Optionaloptions: { maxLength?: number; splitWords?: boolean; suffix?: string | null } = {}
  Options which affect the behavior of text truncation
  - OptionalmaxLength?: number
    The maximum allowed length of the truncated string.
  - OptionalsplitWords?: boolean
    Whether to truncate by splitting on white space (if true) or breaking words.
  - Optionalsuffix?: string | null
    A suffix string to append to denote that the text was truncated.
Returns string
The truncated text string

`Protected` `Static`_applyCustomEnrichers

_applyCustomEnrichers(
    config: TextEditorEnricherConfig,
    text: Text[],
    options?: EnrichmentOptions,
): 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.
- Optionaloptions: EnrichmentOptions
  Options provided to customize text enrichment
Returns Promise<boolean>
Whether any replacements were made, requiring the text nodes to be updated.

`Protected` `Static`_createContentLink

_createContentLink(
match: RegExpMatchArray,
options?: EnrichmentOptions,
): Promise<HTMLAnchorElement>
Protected
Create a dynamic document link from a regular expression match
Parameters
- match: RegExpMatchArray
  The regular expression match
- Optionaloptions: EnrichmentOptions = {}
  Additional options to configure enrichment behaviour
  - Optionalcustom?: boolean
    Apply custom enrichers?
  - Optionaldocuments?: boolean
    Replace dynamic document links?
  - Optionalembeds?: boolean
    Replace embedded content?
  - Optionallinks?: boolean
    Replace hyperlink content?
  - OptionalrelativeTo?: any
    A document to resolve relative UUIDs against.
  - OptionalrollData?: object | Function
    The data object providing context for inline rolls, or a function that produces it.
  - Optionalrolls?: boolean
    Replace inline dice rolls?
  - Optionalsecrets?: boolean
    Include unrevealed secret tags in the final HTML? If false, unrevealed secret blocks will be removed.
Returns Promise<HTMLAnchorElement>
An HTML element for the document link.

`Protected` `Static`_createHyperlink

_createHyperlink(
match: RegExpMatchArray,
options?: EnrichmentOptions,
): Promise<HTMLAnchorElement>
Protected
Replace a hyperlink-like string with an actual HTML <a> tag
Parameters
- match: RegExpMatchArray
  The regular expression match
- Optionaloptions: EnrichmentOptions = {}
  Options provided to customize text enrichment
Returns Promise<HTMLAnchorElement>
An HTML element for the document link

`Protected` `Static`_createInlineRoll

_createInlineRoll(
    match: RegExpMatchArray,
    rollData: object,
    options?: EnrichmentOptions,
): Promise<HTMLAnchorElement | null>
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
- Optionaloptions: EnrichmentOptions = {}
  Options provided to customize text enrichment.
Returns Promise<HTMLAnchorElement | null>
The replaced match. Returns null if the contained command is not a valid roll expression.

`Protected` `Static`_embedContent

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

`Protected` `Static`_enrichContentLinks

_enrichContentLinks(text: Text[], options?: EnrichmentOptions): Promise<boolean>
Protected
Convert text of the form @UUID[uuid]{name} to anchor elements.
Parameters
- text: Text[]
  The existing text content
- Optionaloptions: EnrichmentOptions = {}
  Options provided to customize text enrichment
  - Optionalcustom?: boolean
    Apply custom enrichers?
  - Optionaldocuments?: boolean
    Replace dynamic document links?
  - Optionalembeds?: boolean
    Replace embedded content?
  - Optionallinks?: boolean
    Replace hyperlink content?
  - OptionalrelativeTo?: any
    A document to resolve relative UUIDs against.
  - OptionalrollData?: object | Function
    The data object providing context for inline rolls, or a function that produces it.
  - Optionalrolls?: boolean
    Replace inline dice rolls?
  - Optionalsecrets?: boolean
    Include unrevealed secret tags in the final HTML? If false, unrevealed secret blocks will be removed.
Returns Promise<boolean>
Whether any content links were replaced and the text nodes need to be updated.

`Protected` `Static`_enrichEmbeds

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

`Protected` `Static`_enrichHyperlinks

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

`Protected` `Static`_enrichInlineRolls

_enrichInlineRolls(
    rollData: object | Function,
    text: Text[],
    options?: EnrichmentOptions,
): 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.
- Optionaloptions: EnrichmentOptions = {}
  Options provided to customize text enrichment.
Returns Promise<boolean>
Whether any inline rolls were replaced and the text nodes need to be updated.

`Protected` `Static`_finalizeEnrichedHTML

_finalizeEnrichedHTML(
html: HTMLDivElement,
options: EnrichmentOptions,
): Promise<void>
Protected Internal
A method that can be extended by subclasses to perform final post-enrichment operations on an HTML fragment. Final changes should be made in-place, mutating the provided HTML element. Note: This API is experimental and may be removed in later versions without deprecation.
Parameters
- html: HTMLDivElement
  A div element containing the enriched HTML
- options: EnrichmentOptions
  Provided enrichment options
Returns Promise<void>
A promise which resolves once finalization has completed

`Protected` `Static`_onClickInlineRoll

_onClickInlineRoll(event: MouseEvent): Promise<any>
Protected
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>

`Protected` `Static`_parseEmbedConfig

_parseEmbedConfig(raw: string, options?: object): DocumentHTMLEmbedConfig
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.
- Optionaloptions: object = {}
  Options forwarded to parseUuid.
Returns DocumentHTMLEmbedConfig
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"] }
```

`Protected` `Static`_primeCompendiums

_primeCompendiums(text: Text[], options?: EnrichmentOptions): 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.
- Optionaloptions: EnrichmentOptions = {}
  Options provided to customize text enrichment
Returns Promise<void>

`Protected` `Static`_replaceTextContent

_replaceTextContent(
    text: Text[],
    rgx: RegExp,
    func: TextContentReplacer,
    options?: TextReplacementOptions,
): boolean
Protected
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
- Optionaloptions: TextReplacementOptions = {}
  Options to configure text replacement behavior.
Returns boolean
Whether a replacement was made.

Class TextEditor

Index

Accessors

Methods

Accessors

Staticimplementation

Returns typeof applications.ux.TextEditor

Methods

Static_uploadImage

Parameters

Returns Promise<string | void>

StaticactivateListeners

Parameters

Returns void

Staticcreate

Parameters

Optionalengine?: string

Returns ProseMirrorEditor

StaticcreateAnchor

Parameters

Returns HTMLAnchorElement

StaticdecodeHTML

Parameters

Returns string

StaticenrichHTML

Parameters

Returns Promise<string>

StaticgetContentLink

Parameters

Optionallabel?: string

OptionalrelativeTo?: any

Returns Promise<string | null>

StaticgetDragEventData

Parameters

Returns object

StaticpreviewHTML

Parameters

Returns string

StatictruncateHTML

Parameters

Returns HTMLElement

StatictruncateText

Parameters

OptionalmaxLength?: number

OptionalsplitWords?: boolean

Optionalsuffix?: string | null

Returns string

Protected Static_applyCustomEnrichers

Parameters

Returns Promise<boolean>

Protected Static_createContentLink

Parameters

Optionalcustom?: boolean

Optionaldocuments?: boolean

Optionalembeds?: boolean

Optionallinks?: boolean

OptionalrelativeTo?: any

OptionalrollData?: object | Function

Optionalrolls?: boolean

Optionalsecrets?: boolean

Returns Promise<HTMLAnchorElement>

Protected Static_createHyperlink

Parameters

Returns Promise<HTMLAnchorElement>

Protected Static_createInlineRoll

Parameters

Returns Promise<HTMLAnchorElement | null>

Protected Static_embedContent

Parameters

Returns Promise<HTMLElement | null>

Protected Static_enrichContentLinks

Parameters

Optionalcustom?: boolean

Optionaldocuments?: boolean

Optionalembeds?: boolean

Optionallinks?: boolean

OptionalrelativeTo?: any

OptionalrollData?: object | Function

Optionalrolls?: boolean

Optionalsecrets?: boolean

`Static`implementation

`Static`_uploadImage

`Static`activateListeners

`Static`create

`Optional`engine?: string

`Static`createAnchor

`Static`decodeHTML

`Static`enrichHTML

`Static`getContentLink

`Optional`label?: string

`Optional`relativeTo?: any

`Static`getDragEventData

`Static`previewHTML

`Static`truncateHTML

`Static`truncateText

`Optional`maxLength?: number

`Optional`splitWords?: boolean

`Optional`suffix?: string | null

`Protected` `Static`_applyCustomEnrichers

`Protected` `Static`_createContentLink

`Optional`custom?: boolean

`Optional`documents?: boolean

`Optional`embeds?: boolean

`Optional`links?: boolean

`Optional`relativeTo?: any

`Optional`rollData?: object | Function

`Optional`rolls?: boolean

`Optional`secrets?: boolean

`Protected` `Static`_createHyperlink

`Protected` `Static`_createInlineRoll

`Protected` `Static`_embedContent

`Protected` `Static`_enrichContentLinks

`Optional`custom?: boolean

`Optional`documents?: boolean

`Optional`embeds?: boolean

`Optional`links?: boolean

`Optional`relativeTo?: any

`Optional`rollData?: object | Function

`Optional`rolls?: boolean

`Optional`secrets?: boolean

`Protected` `Static`_enrichEmbeds

`Protected` `Static`_enrichHyperlinks

`Protected` `Static`_enrichInlineRolls

`Protected` `Static`_finalizeEnrichedHTML

`Protected` `Static`_onClickInlineRoll

`Protected` `Static`_parseEmbedConfig

`Protected` `Static`_primeCompendiums

`Protected` `Static`_replaceTextContent