Class RibbonsOptions

Ribbons options class

Implements

Index

Constructors

Properties

colors count disableForReducedMotion emitterSize positionX ribbonOptions scalar zIndex

Accessors

origin particleCount position

Methods

Constructors

constructor

new RibbonsOptions(): RibbonsOptions
Creates a new RibbonsOptions instance with default values

Returns RibbonsOptions
- Defined in bundles/ribbons/src/RibbonsOptions.ts:43

Properties

colors

colors: SingleOrMultiple<string>

Ribbon colors

count

count: number

Number of ribbon particles to emit

disableForReducedMotion

disableForReducedMotion: boolean

Disables ribbons for users who prefer reduced motion

emitterSize

emitterSize: IDimension

Emitter size for particle spawn area

positionX

positionX: number

Ribbons horizontal spawn position (percent)

ribbonOptions

ribbonOptions: SingleOrMultiple<IShapeValues>

Ribbon shape options

scalar

scalar: number

Ribbons size scalar

zIndex

zIndex: number

Ribbons z-index

Accessors

origin

get origin(): ICoordinates
Returns ICoordinates
the origin of the ribbons

Deprecated
use positionX instead
Implementation of IRibbonsOptions.origin
- Defined in bundles/ribbons/src/RibbonsOptions.ts:83
set origin(value: ICoordinates): void
Parameters
- value: ICoordinates
Returns void
Deprecated
use positionX instead
Implementation of IRibbonsOptions.origin
- Defined in bundles/ribbons/src/RibbonsOptions.ts:93

particleCount

get particleCount(): number
Returns number
the number of particles

Deprecated
use count instead
Implementation of IRibbonsOptions.particleCount
- Defined in bundles/ribbons/src/RibbonsOptions.ts:101
set particleCount(value: number): void
Parameters
- value: number
Returns void
Deprecated
use count instead
Implementation of IRibbonsOptions.particleCount
- Defined in bundles/ribbons/src/RibbonsOptions.ts:108

position

get position(): ICoordinates
Returns ICoordinates
the ribbons horizontal position

Deprecated
use positionX instead
Implementation of IRibbonsOptions.position
- Defined in bundles/ribbons/src/RibbonsOptions.ts:116
set position(value: ICoordinates): void
Parameters
- value: ICoordinates
Returns void
Deprecated
use positionX instead
Implementation of IRibbonsOptions.position
- Defined in bundles/ribbons/src/RibbonsOptions.ts:126

Methods

load

load(data?: RecursivePartial<IRibbonsOptions>): void
Loads ribbons options from the provided data
Parameters
- Optionaldata: RecursivePartial<IRibbonsOptions>
  The data to handle
Returns void
Implementation of IOptionLoader.load
- Defined in bundles/ribbons/src/RibbonsOptions.ts:134