Skip to content
Search
Ctrl
K
Cancel
Docs
Reference
Playgrounds
GitHub
npm
Menu
Start here
Introduction
Installation
Quickstart
Migrating from v2
Effects
Confetti
Sparkles
Concepts
How effects work
Samplers & randomness
Behaviors
Shapes
Colors & lighting
Guides
Create a custom effect
Playgrounds
Effects
Shapes
Reference
Overview
Effects
10
confetti()
setDefaultReducedMotion()
sparkles()
BaseEffectOptions
ConfettiOptions
Effect
EffectResult
EffectTarget
ReducedMotion
SparklesOptions
Custom effects
15
createEffect()
createLighting()
emitFrom()
measureTarget()
CreateEffectOptions
CreateLightingOptions
DiskEmissionShape
EmissionBurst
EmissionSchedule
EmissionShape
LightingFn
Live
MeasuredTarget
ParticleInit
RectEmissionShape
Samplers
15
cone()
evaluateSampler()
gradient()
normal()
pick()
randomHue()
randomOrientation()
randomSpin()
range()
spread()
GradientStop
RandomHueOptions
Sampler
SamplerContext
SamplerFn
Particles
10
CircleShape
CustomShape
ImageShape
Particle
ParticleShape
PathShape
PolygonShape
SquareShape
StarShape
TextShape
Behaviors
17
drag()
fade()
gravity()
linear()
scale()
sineIn()
sineInOut()
sineOut()
twinkle()
Behavior
BehaviorInit
BehaviorInitContext
BehaviorObject
BehaviorUpdate
BehaviorUpdateContext
Easing
TwinkleOptions
Utilities
7
color()
Color
PartyJSError
Quat
Rng
Vec2
Vec3
GitHub
npm
Reference
/
Utilities
Interface
Vec2
A 2D vector.
A vector in 2D space.
Properties
Section titled “Properties”
x
number
y
number
