TextManager

Extends EditorManager.

class TextManager extends EditorManager {}

Constructs a new instance of the TextManager class

Parameters

Editor;

Properties

protected readonly disposables: Set<() => void>;

protected readonly editor: Editor;

Methods

Subscribe to an editor bus event and register the matching unsubscribe, so the listener is removed automatically on dispose().

protected addEditorEvent<E extends keyof TLEventMap>(
  event: E,
  fn: (...args: TLEventMap[E]) => void,
): void;

Parameters

E;

(...args: TLEventMap[E]) => void;

Returns

void;

Given an html element, measure the position of each span of unbroken word/white-space characters within any text nodes it contains.

measureElementTextNodeSpans(
  element: HTMLElement,
  {
    shouldTruncateToFirstLine,
  }?: {
    shouldTruncateToFirstLine?: boolean;
  },
): {
  didTruncate: boolean;
  spans: {
    box: BoxModel;
    text: string;
  }[];
};

Parameters

HTMLElement;

{
  shouldTruncateToFirstLine?: boolean;
};

Returns

{
  didTruncate: boolean;
  spans: {
    box: BoxModel;
    text: string;
  }[];
};

measureHtml(html: string, opts: TLMeasureTextOpts): TLMeasuredTextSize;

Parameters

string;

TLMeasureTextOpts;

Returns

TLMeasuredTextSize;

measureHtmlBatch(requests: BatchMeasurementRequest[]): TLMeasuredTextSize[];

Parameters

BatchMeasurementRequest[];

Returns

TLMeasuredTextSize[];

measureText(
  textToMeasure: string,
  opts: TLMeasureTextOpts,
): TLMeasuredTextSize;

Parameters

string;

TLMeasureTextOpts;

Returns

TLMeasuredTextSize;

Measure text into individual spans. Spans are created by rendering the text, then dividing it up according to line breaks and word boundaries.

It works by having the browser render the text, then measuring the position of each character. You can use this to replicate the text-layout algorithm of the current browser in e.g. an SVG export.

measureTextSpans(
  textToMeasure: string,
  opts: TLMeasureTextSpanOpts,
): {
  box: BoxModel;
  text: string;
}[];

Parameters

string;

TLMeasureTextSpanOpts;

Returns

{
  box: BoxModel;
  text: string;
}[];

Register a teardown function to run on dispose(). The universal way for a manager to make a resource "see itself out". Returns the same function for convenience.

protected register(dispose: () => void): () => void;

Parameters

() => void;

Returns

() => void;