Interface ISplitTextStaticProps

Static properties for the SplitText module

interface ISplitTextStaticProps {
    __staticProp?: null;
    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;
    resizeDebounce?: number;
    wordClass?: string;
    wordTag?: keyof HTMLElementTagNameMap;
}

Hierarchy (View Summary)

Properties

__staticProp? container ignore? letterClass? letters? letterTag? lineClass? lines? linesWrapper? lineTag? lineWrapperClass? resizeDebounce? wordClass? wordTag?

Properties

Optional__staticProp

__staticProp?: null

container

container: HTMLElement

The text container where the text will be split.

Optionalignore

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

Do not split certain elements. Supports string selectors, array of elements, or function.

Default

null

OptionalletterClass

letterClass?: string

Letter class name.

Default

v-split-text__letter

Optionalletters

letters?: boolean

Specifies whether the text should be split into individual letters.

Default

false

OptionalletterTag

letterTag?: keyof HTMLElementTagNameMap

HTML tag to wrap each letter.

Default

span

OptionallineClass

lineClass?: string

Line class name.

Default

v-split-text__line

Optionallines

lines?: boolean

Specifies whether the text should be split into lines.

Default

false

OptionallinesWrapper

linesWrapper?: boolean

Specifies whether to wrap each line in an additional container.

Default

false

OptionallineTag

lineTag?: keyof HTMLElementTagNameMap

HTML tag to wrap each line.

Default

span

OptionallineWrapperClass

lineWrapperClass?: string

Line wrapper class name.

Default

v-split-text__line-wrapper

OptionalresizeDebounce

resizeDebounce?: number

The debounce delay for the resize event in milliseconds.

Default

0

OptionalwordClass

wordClass?: string

Word class name.

Default

v-split-text__word

OptionalwordTag

wordTag?: keyof HTMLElementTagNameMap

HTML tag to wrap each word.

Default

span

Settings

Member Visibility

On This Page

Properties