Type Alias ShapeHandler<TEntry>

Shape Handler. Turns one shapes[] entry into a resolved, spawnable shape. Built-in handlers (starShape, emojiShape …) are registered automatically by konfeti; with konfeti/lite register only the ones you use.

type ShapeHandler<TEntry extends { type: string }> = {
    resolve: (entry: TEntry, context: ShapeHandlerContext) => ResolvedShape;
    styleDefaults?: ShapeStyle;
    type: TEntry["type"];
}

Type Parameters

TEntry extends { type: string }

Index

Properties

resolve styleDefaults? type

Properties

`Readonly`resolve

resolve: (entry: TEntry, context: ShapeHandlerContext) => ResolvedShape

Resolve Entry.

`Optional` `Readonly`styleDefaults

styleDefaults?: ShapeStyle

Style Defaults for This Type (below paper and entry styles).

`Readonly`type

type: TEntry["type"]

Handled Shape Type.