Skip to content

Kaleidoscope API

Kaleidoscope

Extends Effect.

Factory Function

typescript
createKaleidoscope(config?: KaleidoscopeConfig)

Methods

See Effect for the full method reference.


KaleidoscopeConfig

typescript
interface KaleidoscopeConfig {
    colors?: string[];
    scale?: number;
    segments?: number;
    shapes?: number;
    speed?: number;
}
PropertyTypeDefaultDescription
colorsstring[]['#ff6b6b', '#4ecdc4', '#45b7d1', '#f7dc6f', '#bb8fce']Colors used for the shapes.
scalenumber1Scales all sizes proportionally.
segmentsnumber8Number of symmetry segments.
shapesnumber15Number of shapes rendered per segment.
speednumber1Rotation and morphing speed.

KaleidoscopeShape

Represents a single shape within the kaleidoscope pattern. Used internally by the effect.