Skip to content
pixi-silk
GitHub repository
Entry point

pixi-silk/ui/button

SilkButton: pill, circle or squircle button with press, hold, busy and appear animations.

import { SilkButton } from 'pixi-silk/ui/button';

Classes#

ClassDescription
SilkButtonA button that animates in and out, refuses input while it moves and keeps its state in signals.

Interfaces#

InterfaceDescription
ButtonStateThe reactive state of a SilkButton. Write shown, enabled and busy, read the rest.
ButtonThemeColours of a SilkButton (any Pixi colour).
SilkButtonOptionsOptions of SilkButton.

Type Aliases#

Type AliasDescription
ButtonPhaseWhere a button is in its show / hide cycle.

Variables#

VariableDescription
BUTTON_THEMEDefault theme: a blue filled button with white content. Merge a Partial<ButtonTheme> over it with the theme option.