pixi-silk/ui/halo

ContextHalo: a ring of actions around a selected object.

import { ContextHalo } from 'pixi-silk/ui/halo';

Classes#

Class	Description
ContextHalo	Action buttons orbiting the selected object. It follows the target every frame from its bounds, so it tracks drags, tweens and camera moves. The buttons sit on an arc hugging the target’s box, on the preferred side. When that side would leave `bounds` the arc turns to the side with the most room. Buttons pop in with a stagger and pop out on `detach()`.

Interface	Description
ContextHaloOptions	Options of ContextHalo. Lengths are in the halo’s local units.
HaloBounds	Rectangle in the halo’s coordinates (its parent’s, while the halo sits at 0, 0 unscaled).
HaloItem	One action of a ContextHalo.
HaloState	The reactive state of a ContextHalo.
HaloTheme	Colours of a ContextHalo (any Pixi colour).

Type Alias	Description
HaloPhase	Where a ContextHalo is in its pop cycle.

Variable	Description
HALO_THEME	Default theme: light buttons with a blue hover.