Class SplitText<StaticProps, ChangeableProps, CallbacksTypes>

Split text into letters, words & lines. Usually used for text animation.

Type Parameters

StaticProps extends NSplitText.IStaticProps = NSplitText.IStaticProps
ChangeableProps extends NSplitText.IChangeableProps = NSplitText.IChangeableProps
CallbacksTypes extends NSplitText.ICallbacksTypes = NSplitText.ICallbacksTypes

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- SplitText

Constructors

constructor

new SplitText<StaticProps, ChangeableProps, CallbacksTypes>(initialProps, canInit?): SplitText<StaticProps, ChangeableProps, CallbacksTypes>
Type Parameters
- StaticProps extends NSplitText.IStaticProps = NSplitText.IStaticProps
- ChangeableProps extends NSplitText.IChangeableProps = NSplitText.IChangeableProps
- CallbacksTypes extends NSplitText.ICallbacksTypes = NSplitText.ICallbacksTypes
Parameters
- initialProps: StaticProps & ChangeableProps
- canInit: boolean = true
Returns SplitText<StaticProps, ChangeableProps, CallbacksTypes>
Overrides Component.constructor
- Defined in src/components/SplitText/index.ts:76

Properties

`Protected` _container

_container: HTMLElement

Text container

`Protected` _initialHTML

_initialHTML: string

Initial HTML content

`Protected` _initialText

_initialText: string

Initial text

`Protected` _isBaseSplit

_isBaseSplit: boolean

If the text is already split into letters and words

`Protected` _letters

_letters: ILetter[]

Letters

`Protected` _lines

_lines: ILine[]

Lines

`Protected` _words

_words: IWord[]

Words

Accessors

app

get app(): Application
Vevet Application

Returns Application
Inherited from ComponentClass.app
- Defined in src/base/Module/index.ts:68

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Module Callbacks

Returns Callbacks<CallbacksTypes>
Inherited from ComponentClass.callbacks
- Defined in src/base/Module/index.ts:47

container

get container(): HTMLElement
Text container

Returns HTMLElement
- Defined in src/components/SplitText/index.ts:48

isDestroyed

get isDestroyed(): boolean
The module is destroyed

Returns boolean
Inherited from ComponentClass.isDestroyed
- Defined in src/base/Module/index.ts:94

isInitialized

get isInitialized(): boolean
The module is initialized

Returns boolean
Inherited from ComponentClass.isInitialized
- Defined in src/base/Module/index.ts:86

letters

get letters(): ILetter[]
Letters

Returns ILetter[]
- Defined in src/components/SplitText/index.ts:56

lines

get lines(): ILine[]
Lines

Returns ILine[]
- Defined in src/components/SplitText/index.ts:72

name

get name(): string
Module name

Returns string
Inherited from ComponentClass.name
- Defined in src/base/Module/index.ts:73

prefix

get prefix(): string
Module prefix

Returns string
Overrides ComponentClass.prefix
- Defined in src/components/SplitText/index.ts:31

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
Current properties

Returns TRequiredModuleProp<StaticProps & ChangeableProps>
Inherited from ComponentClass.props
- Defined in src/base/Module/index.ts:34

words

get words(): IWord[]
Words

Returns IWord[]
- Defined in src/components/SplitText/index.ts:64

Methods

`Protected` _appendWords

_appendWords(): void
Append split words to the container

Returns void
- Defined in src/components/SplitText/index.ts:288

`Protected` _destroy

_destroy(): void
Destroy the module

Returns void
Overrides Component._destroy
- Defined in src/components/SplitText/index.ts:384

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    container: string;
    hasLetters: boolean;
    hasLines: boolean;
    resizeDebounce: number;
    textSource: string;
    viewportTarget: string;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
    container: string;
    hasLetters: boolean;
    hasLines: boolean;
    resizeDebounce: number;
    textSource: string;
    viewportTarget: string;
}
Overrides Component._getDefaultProps
- Defined in src/components/SplitText/index.ts:19

`Protected` _init

_init(): void
Inner extra initialization

Returns void
Overrides Component._init
- Defined in src/components/SplitText/index.ts:110

`Protected` _onPropsMutate

_onPropsMutate(): void
This method is called on properties change

Returns void
Inherited from Component._onPropsMutate
- Defined in src/base/Module/index.ts:197

`Protected` _removeLines

_removeLines(): void
Remove all lines

Returns void
- Defined in src/components/SplitText/index.ts:376

`Protected` _setResize

_setResize(): void
Set resize events

Returns void
- Defined in src/components/SplitText/index.ts:117

`Protected` _splitIntoLetters

_splitIntoLetters(): void
Split the text into letters

Returns void
- Defined in src/components/SplitText/index.ts:249

`Protected` _splitIntoLines

_splitIntoLines(): void
Split the text into lines

Returns void
- Defined in src/components/SplitText/index.ts:303

`Protected` _splitIntoWords

_splitIntoWords(): void
Split the text into words

Returns void
- Defined in src/components/SplitText/index.ts:161

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Add a module callback
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
- action: TAction<CallbacksTypes[T]>
- settings: ISettings = {}
Returns IAddedCallback
Inherited from Component.addCallback
- Defined in src/base/Module/index.ts:245

`Protected` addDestroyableAction

addDestroyableAction(action): void
Add destroyable actions
Parameters
- action: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from Component.addDestroyableAction
- Defined in src/base/Module/index.ts:224

addEventListener

addEventListener<El, Target, Callback>(el, target, callback, options?): IAddEventListener
Add a DOM event listener
Type Parameters
- El extends ListenerElement
- Target extends keyof HTMLElementEventMap
- Callback extends ((evt) => void)
Parameters
- el: El
- target: Target
- callback: Callback
- Optional options: IAddEventListenerOptions
Returns IAddEventListener
Inherited from Component.addEventListener
- Defined in src/base/Module/index.ts:254

addPlugin

addPlugin<T>(plugin): void
Add a single plugin
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
Returns void
Inherited from Component.addPlugin
- Defined in src/base/Component/index.ts:21

addResponsiveProps

addResponsiveProps(rules): void
Add responsive rules
Parameters
- rules: IResponsive<ChangeableProps>
Returns void
Inherited from Component.addResponsiveProps
- Defined in src/base/Module/index.ts:173

addViewportCallback

addViewportCallback(target, action, data?): void
Add a viewport callback that will be removed on class destroy
Parameters
- target: keyof NViewport.ICallbacksTypes
- action: ((arg) => void)
  - - (arg): void
    - Parameters
      
      arg: IChanges
      
      Returns void
- data: undefined | ISettings = {}
Returns void
Inherited from Component.addViewportCallback
- Defined in src/base/Module/index.ts:231

changeProps

changeProps(props): void
Change module properties
Parameters
- props: Partial<ChangeableProps>
Returns void
Inherited from Component.changeProps
- Defined in src/base/Module/index.ts:184

`Protected` className

className(...classNames): string
Parameters
- Rest ...classNames: string[]
Returns string
Inherited from Component.className
- Defined in src/base/Module/index.ts:279

destroy

destroy(): void
Destroy the module

Returns void
Inherited from Component.destroy
- Defined in src/base/Module/index.ts:299

init

init(): void
Initializes the class

Returns void
Inherited from Component.init
- Defined in src/base/Module/index.ts:202

splitText

splitText(): void
Split the text

Returns void
- Defined in src/components/SplitText/index.ts:139

`Protected` toggleClassName

toggleClassName(element, className, isActive): void
Toggle classList
Parameters
- element: Element
- className: string
- isActive: boolean
Returns void
Inherited from Component.toggleClassName
- Defined in src/base/Module/index.ts:284