Skip to main content

Interface: CustomElementOptions<Props extends Record<string, number>>

Custom drawing options. Properties use author-defined units.

Extends​

Type Parameters​

Type Parameter
Props extends Record<string, number>

Properties​

PropertyTypeDescription
align?Align-
blur?numberBlur in virtual pixels (default: 0).
brightness?numberBrightness multiplier (default: 1).
className?string-
color?stringForeground CSS color (default: component/theme color).
customPositioned?booleanWhether this element manages its own CSS transform / positioning (disables stage translate3d).
enterDelay?numberDelay in seconds before entering scene transition begins.
enterDuration?numberDuration in seconds for entering scene transition.
exitDelay?numberDelay in seconds before exiting scene transition begins.
exitDuration?numberDuration in seconds for exiting scene transition.
height?SizeHeight in stage units or CSS length (default: content size).
id?string-
onActivate?() => void-
onDeactivate?() => void-
onDraw(props: Readonly<{ [K in keyof Props]: number }>, node: HTMLElement) => voidDraws initial values, transition frames, and restored snapshots. No independent loop.
onMount?() => void-
onUnmount?() => void-
opacity?numberWhole-element opacity from 0 to 1 (default: 1).
origin?ElementAnchorWhich point of the element sits on its coordinate (default: "top-left").
position?Position-
propsProps & { [K in string | number | symbol as K extends `_${string}` | (keyof DOMElement) ? K : never]: never }Initial numeric values. Required; no defaults.
rotation?numberRotation in degrees (default: 0).
scale?numberScale multiplier (default: 1).
size?SizeBoth dimensions in stage units or CSS length (default: unset).
style?Properties<0 | string & object, string & object>-
theme?Partial<ThemeConfig>-
width?SizeWidth in stage units or CSS length (default: content size).
x?PositionCoordHorizontal position in stage units (default: 0).
y?PositionCoordVertical position in stage units (default: 0).