Function ribbons

ribbons(
idOrOptions?: RibbonsFirstParam,
ribbonsOptions?: RecursivePartial<IRibbonsOptions>,
): Promise<Container | undefined>
Parameters
- OptionalidOrOptions: RibbonsFirstParam
  the id used for the canvas, or if not using two parameters, the animation configuration object
- OptionalribbonsOptions: RecursivePartial<IRibbonsOptions>
  the animation configuration object, this parameter is mandatory only if providing an id
Returns Promise<Container | undefined>
the container of the animation, or undefined if no canvas was found
- Defined in bundles/ribbons/src/ribbons.ts:77

Index

Properties

Methods

Properties

version

version: string

The ribbons bundle version

Methods

create

create(
canvas?: HTMLCanvasElement | null,
options?: RecursivePartial<IRibbonsOptions>,
): Promise<RibbonsFunc>
Parameters
- Optionalcanvas: HTMLCanvasElement | null
  The canvas
- options: RecursivePartial<IRibbonsOptions> = {}
  The options to handle
Returns Promise<RibbonsFunc>
the ribbons function to use for the given canvas animations
- Defined in bundles/ribbons/src/ribbons.ts:105

init

init(): Promise<void>
Initializes the ribbons plugins without creating an animation

Returns Promise<void>
- Defined in bundles/ribbons/src/ribbons.ts:144