ITextMaskProps
interface
Data Display
Props for <OrigamTextMask> — a typographic "window" component that paints text as a transparent fill over an animated background (background-clip: text). Accepts gradient objects, raw CSS gradient strings, preset names or image URLs.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- textstring
- Text to mask. Ignored when the default slot is provided.
- backgroundrequiredstring | IGradient
- Background painted behind the text glyphs. Accepts a gradient object, raw CSS gradient string, preset name or image URL. Required.
- animatedbooleanfalse
- Animates the background. Combined with animationType to pick a keyframe set.
- animationDurationstring'3s'
- Duration of one animation cycle. Accepts any CSS <time> value ('3s', '750ms', …).
- animationTypeTTextMaskAnimation'pan'
- Animation strategy. Default is 'pan'.
- alignTBlockquoteAlign'left'
- text-align of the masked content.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Animated gradient headline