File size: 12,412 Bytes
0dbc9de | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 | import type { ColorInput } from "@opentui/core"
import { RGBA } from "@opentui/core"
import type { ColorGenerator } from "opentui-spinner"
interface AdvancedGradientOptions {
colors: ColorInput[]
trailLength: number
defaultColor?: ColorInput
direction?: "forward" | "backward" | "bidirectional"
holdFrames?: { start?: number; end?: number }
enableFading?: boolean
minAlpha?: number
}
interface ScannerState {
activePosition: number
isHolding: boolean
holdProgress: number
holdTotal: number
movementProgress: number
movementTotal: number
isMovingForward: boolean
}
function getScannerState(
frameIndex: number,
totalChars: number,
options: Pick<AdvancedGradientOptions, "direction" | "holdFrames">,
): ScannerState {
const { direction = "forward", holdFrames = {} } = options
if (direction === "bidirectional") {
const forwardFrames = totalChars
const holdEndFrames = holdFrames.end ?? 0
const backwardFrames = totalChars - 1
if (frameIndex < forwardFrames) {
// Moving forward
return {
activePosition: frameIndex,
isHolding: false,
holdProgress: 0,
holdTotal: 0,
movementProgress: frameIndex,
movementTotal: forwardFrames,
isMovingForward: true,
}
} else if (frameIndex < forwardFrames + holdEndFrames) {
// Holding at end
return {
activePosition: totalChars - 1,
isHolding: true,
holdProgress: frameIndex - forwardFrames,
holdTotal: holdEndFrames,
movementProgress: 0,
movementTotal: 0,
isMovingForward: true,
}
} else if (frameIndex < forwardFrames + holdEndFrames + backwardFrames) {
// Moving backward
const backwardIndex = frameIndex - forwardFrames - holdEndFrames
return {
activePosition: totalChars - 2 - backwardIndex,
isHolding: false,
holdProgress: 0,
holdTotal: 0,
movementProgress: backwardIndex,
movementTotal: backwardFrames,
isMovingForward: false,
}
} else {
// Holding at start
return {
activePosition: 0,
isHolding: true,
holdProgress: frameIndex - forwardFrames - holdEndFrames - backwardFrames,
holdTotal: holdFrames.start ?? 0,
movementProgress: 0,
movementTotal: 0,
isMovingForward: false,
}
}
} else if (direction === "backward") {
return {
activePosition: totalChars - 1 - (frameIndex % totalChars),
isHolding: false,
holdProgress: 0,
holdTotal: 0,
movementProgress: frameIndex % totalChars,
movementTotal: totalChars,
isMovingForward: false,
}
} else {
return {
activePosition: frameIndex % totalChars,
isHolding: false,
holdProgress: 0,
holdTotal: 0,
movementProgress: frameIndex % totalChars,
movementTotal: totalChars,
isMovingForward: true,
}
}
}
function calculateColorIndex(
frameIndex: number,
charIndex: number,
totalChars: number,
options: Pick<AdvancedGradientOptions, "direction" | "holdFrames" | "trailLength">,
state?: ScannerState,
): number {
const { trailLength } = options
const { activePosition, isHolding, holdProgress, isMovingForward } =
state ?? getScannerState(frameIndex, totalChars, options)
// Calculate directional distance (positive means trailing behind)
const directionalDistance = isMovingForward
? activePosition - charIndex // For forward: trail is to the left (lower indices)
: charIndex - activePosition // For backward: trail is to the right (higher indices)
// Handle hold frame fading: keep the lead bright, fade the trail
if (isHolding) {
// Shift the color index by how long we've been holding
return directionalDistance + holdProgress
}
// Normal movement - show gradient trail only behind the movement direction
if (directionalDistance > 0 && directionalDistance < trailLength) {
return directionalDistance
}
// At the active position, show the brightest color
if (directionalDistance === 0) {
return 0
}
return -1
}
function createKnightRiderTrail(options: AdvancedGradientOptions): ColorGenerator {
const { colors, defaultColor, enableFading = true, minAlpha = 0 } = options
// Use the provided defaultColor if it's an RGBA instance, otherwise convert/default
// We use RGBA.fromHex for the fallback to ensure we have an RGBA object.
// Note: If defaultColor is a string, we convert it once here.
const defaultRgba = defaultColor instanceof RGBA ? defaultColor : RGBA.fromHex((defaultColor as string) || "#000000")
// Store the base alpha from the inactive factor
const baseInactiveAlpha = defaultRgba.a
let cachedFrameIndex = -1
let cachedState: ScannerState | null = null
return (frameIndex: number, charIndex: number, _totalFrames: number, totalChars: number) => {
if (frameIndex !== cachedFrameIndex) {
cachedFrameIndex = frameIndex
cachedState = getScannerState(frameIndex, totalChars, options)
}
const state = cachedState!
const index = calculateColorIndex(frameIndex, charIndex, totalChars, options, state)
// Calculate global fade for inactive dots during hold or movement
const { isHolding, holdProgress, holdTotal, movementProgress, movementTotal } = state
let fadeFactor = 1.0
if (enableFading) {
if (isHolding && holdTotal > 0) {
// Fade out linearly to minAlpha
const progress = Math.min(holdProgress / holdTotal, 1)
fadeFactor = Math.max(minAlpha, 1 - progress * (1 - minAlpha))
} else if (!isHolding && movementTotal > 0) {
// Fade in linearly from minAlpha during movement
const progress = Math.min(movementProgress / Math.max(1, movementTotal - 1), 1)
fadeFactor = minAlpha + progress * (1 - minAlpha)
}
}
// Combine base inactive alpha with the fade factor
// This ensures inactiveFactor is respected while still allowing fading animation
defaultRgba.a = baseInactiveAlpha * fadeFactor
if (index === -1) {
return defaultRgba
}
return colors[index] ?? defaultRgba
}
}
/**
* Derives a gradient of tail colors from a single bright color using alpha falloff
* @param brightColor The brightest color (center/head of the scanner)
* @param steps Number of gradient steps (default: 6)
* @returns Array of RGBA colors with alpha-based trail fade (background-independent)
*/
export function deriveTrailColors(brightColor: ColorInput, steps: number = 6): RGBA[] {
const baseRgba = brightColor instanceof RGBA ? brightColor : RGBA.fromHex(brightColor as string)
const colors: RGBA[] = []
for (let i = 0; i < steps; i++) {
// Alpha-based falloff with optional bloom effect
let alpha: number
let brightnessFactor: number
if (i === 0) {
// Lead position: full brightness and opacity
alpha = 1.0
brightnessFactor = 1.0
} else if (i === 1) {
// Slight bloom/glare effect: brighten color but reduce opacity slightly
alpha = 0.9
brightnessFactor = 1.15
} else {
// Exponential alpha decay for natural-looking trail fade
alpha = Math.pow(0.65, i - 1)
brightnessFactor = 1.0
}
const r = Math.min(1.0, baseRgba.r * brightnessFactor)
const g = Math.min(1.0, baseRgba.g * brightnessFactor)
const b = Math.min(1.0, baseRgba.b * brightnessFactor)
colors.push(RGBA.fromValues(r, g, b, alpha))
}
return colors
}
/**
* Derives the inactive/default color from a bright color using alpha
* @param brightColor The brightest color (center/head of the scanner)
* @param factor Alpha factor for inactive color (default: 0.2, range: 0-1)
* @returns The same color with reduced alpha for background-independent dimming
*/
export function deriveInactiveColor(brightColor: ColorInput, factor: number = 0.2): RGBA {
const baseRgba = brightColor instanceof RGBA ? brightColor : RGBA.fromHex(brightColor as string)
// Use the full color brightness but adjust alpha for background-independent dimming
return RGBA.fromValues(baseRgba.r, baseRgba.g, baseRgba.b, factor)
}
export type KnightRiderStyle = "blocks" | "diamonds"
export interface KnightRiderOptions {
width?: number
style?: KnightRiderStyle
holdStart?: number
holdEnd?: number
colors?: ColorInput[]
/** Single color to derive trail from (alternative to providing colors array) */
color?: ColorInput
/** Number of trail steps when using single color (default: 6) */
trailSteps?: number
defaultColor?: ColorInput
/** Alpha factor for inactive color when using single color (default: 0.2, range: 0-1) */
inactiveFactor?: number
/** Enable fading of inactive dots during hold and movement (default: true) */
enableFading?: boolean
/** Minimum alpha value when fading (default: 0, range: 0-1) */
minAlpha?: number
}
/**
* Creates frame strings for a Knight Rider style scanner animation
* @param options Configuration options for the Knight Rider effect
* @returns Array of frame strings
*/
export function createFrames(options: KnightRiderOptions = {}): string[] {
const width = options.width ?? 8
const style = options.style ?? "diamonds"
const holdStart = options.holdStart ?? 30
const holdEnd = options.holdEnd ?? 9
const colors =
options.colors ??
(options.color
? deriveTrailColors(options.color, options.trailSteps)
: [
RGBA.fromHex("#ff0000"), // Brightest Red (Center)
RGBA.fromHex("#ff5555"), // Glare/Bloom
RGBA.fromHex("#dd0000"), // Trail 1
RGBA.fromHex("#aa0000"), // Trail 2
RGBA.fromHex("#770000"), // Trail 3
RGBA.fromHex("#440000"), // Trail 4
])
const defaultColor =
options.defaultColor ??
(options.color ? deriveInactiveColor(options.color, options.inactiveFactor) : RGBA.fromHex("#330000"))
const trailOptions = {
colors,
trailLength: colors.length,
defaultColor,
direction: "bidirectional" as const,
holdFrames: { start: holdStart, end: holdEnd },
enableFading: options.enableFading,
minAlpha: options.minAlpha,
}
// Bidirectional cycle: Forward (width) + Hold End + Backward (width-1) + Hold Start
const totalFrames = width + holdEnd + (width - 1) + holdStart
// Generate dynamic frames where inactive pixels are dots and active ones are blocks
const frames = Array.from({ length: totalFrames }, (_, frameIndex) => {
return Array.from({ length: width }, (_, charIndex) => {
const index = calculateColorIndex(frameIndex, charIndex, width, trailOptions)
if (style === "diamonds") {
const shapes = ["⬥", "◆", "⬩", "⬪"]
if (index >= 0 && index < trailOptions.colors.length) {
return shapes[Math.min(index, shapes.length - 1)]
}
return "·"
}
// Default to blocks
// It's active if we have a valid color index that is within our colors array
const isActive = index >= 0 && index < trailOptions.colors.length
return isActive ? "■" : "⬝"
}).join("")
})
return frames
}
/**
* Creates a color generator function for Knight Rider style scanner animation
* @param options Configuration options for the Knight Rider effect
* @returns ColorGenerator function
*/
export function createColors(options: KnightRiderOptions = {}): ColorGenerator {
const holdStart = options.holdStart ?? 30
const holdEnd = options.holdEnd ?? 9
const colors =
options.colors ??
(options.color
? deriveTrailColors(options.color, options.trailSteps)
: [
RGBA.fromHex("#ff0000"), // Brightest Red (Center)
RGBA.fromHex("#ff5555"), // Glare/Bloom
RGBA.fromHex("#dd0000"), // Trail 1
RGBA.fromHex("#aa0000"), // Trail 2
RGBA.fromHex("#770000"), // Trail 3
RGBA.fromHex("#440000"), // Trail 4
])
const defaultColor =
options.defaultColor ??
(options.color ? deriveInactiveColor(options.color, options.inactiveFactor) : RGBA.fromHex("#330000"))
const trailOptions = {
colors,
trailLength: colors.length,
defaultColor,
direction: "bidirectional" as const,
holdFrames: { start: holdStart, end: holdEnd },
enableFading: options.enableFading,
minAlpha: options.minAlpha,
}
return createKnightRiderTrail(trailOptions)
}
|