Interface ISplitTextStaticProps

interface ISplitTextStaticProps {
    __staticProp?: true;
    ariaLabel?: string | boolean;
    container: HTMLElement;
    ignore?: null | string | HTMLElement[] | (element: HTMLElement) => boolean;
    letterClass?: string;
    letters?: boolean;
    letterTag?: keyof HTMLElementTagNameMap;
    lineClass?: string;
    lines?: boolean;
    linesWrapper?: boolean;
    lineTag?: keyof HTMLElementTagNameMap;
    lineWrapperClass?: string;
    prepareText?: (text: string) => string;
    resizeDebounce?: number;
    wordClass?: string;
    wordDelimiter?: string;
    wordDelimiterOutput?: null | string;
    wordTag?: keyof HTMLElementTagNameMap;
}

Hierarchy (View Summary)

Properties

__staticProp? ariaLabel? container ignore? letterClass? letters? letterTag? lineClass? lines? linesWrapper? lineTag? lineWrapperClass? prepareText? resizeDebounce? wordClass? wordDelimiter? wordDelimiterOutput? wordTag?

Properties

Optional__staticProp

__staticProp?: true

OptionalariaLabel

ariaLabel?: string | boolean

Accessible label for the container after splitting.

  • true — uses textContent as aria-label
  • false — does not set aria-label
  • string — uses the provided value

Default

true

container

container: HTMLElement

Container whose text content is split.

Optionalignore

ignore?: null | string | HTMLElement[] | (element: HTMLElement) => boolean

Elements excluded from splitting (selector, list, or predicate).

Default

null

OptionalletterClass

letterClass?: string

CSS class for letter elements.

Default

{prefix}__letter

Optionalletters

letters?: boolean

Split each word into individual letter elements.

Default

false

OptionalletterTag

letterTag?: keyof HTMLElementTagNameMap

HTML tag for letter wrappers.

Default

span

OptionallineClass

lineClass?: string

CSS class for line elements.

Default

{prefix}__line

Optionallines

lines?: boolean

Group words into line elements (reflows on resize).

Default

false

OptionallinesWrapper

linesWrapper?: boolean

Wrap each line in an extra element (useful for mask animations).

Default

false

OptionallineTag

lineTag?: keyof HTMLElementTagNameMap

HTML tag for line wrappers.

Default

span

OptionallineWrapperClass

lineWrapperClass?: string

CSS class for line wrapper elements.

Default

{prefix}__line-wrapper

OptionalprepareText

prepareText?: (text: string) => string

Preprocesses text before word splitting (e.g. CJK segmentation).

Example

const segmenter = new Intl.Segmenter('zh', { granularity: 'word' });

const instance = new SplitText({
  container,
  prepareText: (source) => [...segmenter.segment(source)].map((s) => s.segment).join(' '),
});

OptionalresizeDebounce

resizeDebounce?: number

Debounce delay for resize-driven line reflow (ms).

Default

0

OptionalwordClass

wordClass?: string

CSS class for word elements.

Default

{prefix}__word

OptionalwordDelimiter

wordDelimiter?: string

Delimiter used to split text into words.

Default

whitespace

OptionalwordDelimiterOutput

wordDelimiterOutput?: null | string

Delimiter inserted between words in the DOM (defaults to wordDelimiter).

Default

null

OptionalwordTag

wordTag?: keyof HTMLElementTagNameMap

HTML tag for word wrappers.

Default

span

Settings

Member Visibility

On This Page

Properties