segmentText()

Split segmented text into render-ready pieces.

Import

import { segmentText } from "@graphrefly/ts/solutions/reactive-layout";

Signature

function segmentText(
  text: string,
  segmentAdapter: SegmentAdapter,
): {
  readonly texts: string[];
  readonly isWordLike: boolean[];
  readonly kinds: SegmentBreakKind[];
}[]

Parameters

Parameter	Type	Description
text	string	Input text.
segmentAdapter	SegmentAdapter	Segment adapter used to split words and graphemes.

Returns

Segment pieces with text, word-like, and break-kind arrays.

Example

segmentText("Hello world", getDefaultSegmentAdapter());

Source

packages/ts/src/solutions/reactive-layout/segment.ts