core/dev.kindling.core.components.ui.animated/KSpecialText

KSpecialText

fun KSpecialText(text: String, modifier: Modifier = Modifier, effect: KSpecialEffect = KSpecialEffect.SHIMMER, visible: Boolean = true, style: TextStyle = LocalTextStyle.current, scrambleSpeedMs: Long = KSpecialTextDefaults.ScrambleSpeedMs, scrambleDelayMs: Long = 0, colors: List<Color> = if (effect == KSpecialEffect.RAINBOW) KSpecialTextDefaults.RainbowColors else KSpecialTextDefaults.ShimmerColors, glowColor: Color = KSpecialTextDefaults.GlowColor, glowRadius: Dp = KSpecialTextDefaults.GlowRadius, speedMs: Int = KSpecialTextDefaults.SpeedMs, sparkleCount: Int = KSpecialTextDefaults.SparkleCount)(source)

Enhanced text component supporting character scramble animations (inspired by Spell.sh / React SpecialText), gradient shimmers, pulsating neon glows, rainbow shifts, and particle sparkles.

Parameters

text

Content string to display.

modifier

Applied to the outer layout box.

effect

Visual effect mode (KSpecialEffect.SCRAMBLE, KSpecialEffect.SHIMMER, KSpecialEffect.RAINBOW, KSpecialEffect.NEON_GLOW, or KSpecialEffect.SPARKLE).

visible

Controls whether scramble animation runs or resets.

style

Typography style configuration.

scrambleSpeedMs

Interval in milliseconds per frame step during KSpecialEffect.SCRAMBLE.

scrambleDelayMs

Delay in milliseconds prior to starting the scramble sequence.

colors

Gradient colors used for shimmer or rainbow sweeps.

glowColor

Glow tint for KSpecialEffect.NEON_GLOW.

glowRadius

Blur radius for KSpecialEffect.NEON_GLOW.

speedMs

Animation cycle duration in milliseconds for continuous effects.

sparkleCount

Number of floating star sparkles when using KSpecialEffect.SPARKLE.