Skip to content

Coral Reef API

CoralReef

Extends Effect.

Factory Function

typescript
createCoralReef(config?: CoralReefConfig)

Methods

See Effect for the full method reference.


CoralReefConfig

typescript
interface CoralReefConfig {
    anemones?: number;
    bubbles?: number;
    colors?: string[];
    jellyfish?: number;
    scale?: number;
    speed?: number;
}
PropertyTypeDefaultDescription
anemonesnumber8Number of sea anemones.
bubblesnumber20Number of rising bubbles.
colorsstring[]['#ff6b9d', '#c44dff', '#00d4aa', '#ff8c42', '#4dc9f6']Colors for coral, anemones, and jellyfish.
jellyfishnumber5Number of jellyfish.
scalenumber1Scales all sizes proportionally.
speednumber1Animation speed multiplier.