Class SplitText<StaticProps, ChangeableProps, CallbacksTypes>

SplitText is a component that splits your text into lines, words, and letters so that you can animate them. It supports auto-resizing for lines and styled content when using HTML inside your text.

Inspired by GSAP's SplitText plugin and SplitType.

P.S. Apply fontKerning: none to your container to prevent large layout shifts.

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- SplitText

Index

Constructors

constructor

Accessors

callbacks container isDestroyed isInitialized letterClassName letters lineClassName lines name prefix props wordClassName words

Methods

addCallback addEventListener addPlugin addResponsiveProps addViewportCallback changeProps destroy init 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:139

Accessors

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Retrieves the module's registered callbacks.

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

container

get container(): HTMLElement
Returns the text container element.

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

isDestroyed

get isDestroyed(): boolean
Checks if the module has been destroyed.

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

isInitialized

get isInitialized(): boolean
Checks if the module has been initialized.

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

letterClassName

get letterClassName(): string
Class name used for individual letters.

Returns string
- Defined in src/components/SplitText/index.ts:57

letters

get letters(): ILetter[]
Returns the list of letter elements.

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

lineClassName

get lineClassName(): string
Class name used for individual lines.

Returns string
- Defined in src/components/SplitText/index.ts:71

lines

get lines(): ILine[]
Returns the list of line elements.

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

name

get name(): string
The name of the module, derived from the class name

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

prefix

get prefix(): string
Optional prefix for class names used by the module

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

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
The current properties of the module, which include both static and changeable properties. These can be retrieved dynamically during the module's lifecycle.

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

wordClassName

get wordClassName(): string
Class name used for individual words.

Returns string
- Defined in src/components/SplitText/index.ts:64

words

get words(): IWord[]
Returns the list of word elements.

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

Methods

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Adds a custom callback to the module.
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
  
  The event type to listen for (e.g., 'propsChange', 'destroy').
- action: TAction<CallbacksTypes[T]>
  
  The function to execute when the event is triggered.
- settings: ISettings = {}
  
  Additional settings for the callback.
Returns IAddedCallback
Inherited from Component.addCallback
- Defined in src/base/Module/index.ts:245

addEventListener

addEventListener<Target, Listener>(element, target, callback, options?): (() => void)
Adds a DOM event listener that will be automatically removed when the module is destroyed.
Type Parameters
- Target extends keyof HTMLElementEventMap
- Listener extends ((event) => void)
Parameters
- element: Document | Element | Window
  
  The target element for the event listener.
- target: Target
  
  The event type to listen for (e.g., 'click', 'resize').
- callback: Listener
  
  The callback function to execute when the event is triggered.
- Optional options: boolean | AddEventListenerOptions
  
  Additional options for the event listener.
Returns (() => void)
- - (): void
  - Returns void
Inherited from Component.addEventListener
- Defined in src/base/Module/index.ts:261

addPlugin

addPlugin<T>(plugin): void
Adds a plugin to the component. The plugin is initialized upon being added, and the plugin's component property is set to the current component instance.
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
  
  An instance of the Plugin class to be added.
Returns void
Inherited from Component.addPlugin
- Defined in src/base/Component/index.ts:30

addResponsiveProps

addResponsiveProps(rules): void
Adds responsive property rules to the module. This must be done before initialization.
Parameters
- rules: IResponsive<ChangeableProps>
  
  The responsive property rules to be added.
Returns void
Inherited from Component.addResponsiveProps
- Defined in src/base/Module/index.ts:159

addViewportCallback

addViewportCallback(target, action, data?): void
Adds a viewport callback that will be automatically removed when the module is destroyed.
Parameters
- target: keyof IViewportCallbackTypes
  
  The viewport target (e.g., width or height).
- action: (() => void)
  
  The callback function to execute when the viewport target changes.
  - - (): void
    - Returns void
- data: undefined | ISettings = {}
  
  Additional data for the callback.
Returns void
Inherited from Component.addViewportCallback
- Defined in src/base/Module/index.ts:225

changeProps

changeProps(props): void
Updates the changeable properties of the module.
Parameters
- props: Partial<ChangeableProps>
  
  The properties to be updated.
Returns void
Inherited from Component.changeProps
- Defined in src/base/Module/index.ts:174

destroy

destroy(): void
Destroys the module, cleaning up resources, callbacks, and event listeners.

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

init

init(): void
Initializes the module. Calls the internal _init method and marks the module as initialized.

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

splitText

splitText(): void
Splits the text in the container into letters, words, and optionally lines, based on the component properties.

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

Class SplitText<StaticProps, ChangeableProps, CallbacksTypes>

Link

Link

See

Type Parameters

StaticProps extends NSplitText.IStaticProps = NSplitText.IStaticProps

ChangeableProps extends NSplitText.IChangeableProps = NSplitText.IChangeableProps

CallbacksTypes extends NSplitText.ICallbacksTypes = NSplitText.ICallbacksTypes

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

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>

Accessors

callbacks

Returns Callbacks<CallbacksTypes>

container

Returns HTMLElement

isDestroyed

Returns boolean

isInitialized

Returns boolean

letterClassName

Returns string

letters

Returns ILetter[]

lineClassName

Returns string

lines

Returns ILine[]

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

wordClassName

Returns string

words

Returns IWord[]

Methods

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

addEventListener

Type Parameters

Target extends keyof HTMLElementEventMap

Listener extends ((event) => void)

Parameters

element: Document | Element | Window

target: Target

callback: Listener

Optional options: boolean | AddEventListenerOptions

Returns (() => void)

Returns void

addPlugin

Type Parameters

T extends Plugin<any, any, any, any>

Parameters

plugin: T

Returns void

addResponsiveProps

Parameters

rules: IResponsive<ChangeableProps>

Returns void

`Optional` options: boolean | AddEventListenerOptions