Skip to content
pixi-silk
GitHub repository
Interface

SelectionOutlineOptions

import type { SelectionOutlineOptions } from 'pixi-silk/ui/outline';

Options of SelectionOutline.

Properties#

PropertyTypeDescriptionDefined in
brackets?booleanDraw corner brackets on the selected frame. Default true.ui/outline.ts:35
bracketSize?numberLength of each corner bracket arm, in outline units. Default 10.ui/outline.ts:37
color?string | numberAccent colour of the selected frame. Default 0x0a84ff.ui/outline.ts:25
dash?[number, number]Dash and gap lengths of the selected frame, in outline units. Default [5, 4].ui/outline.ts:31
fillAlpha?numberAlpha of the accent tint inside the selected frame, 0 to 1. Default 0.05.ui/outline.ts:39
hoverColor?string | numberColour of the hover line. Default the accent.ui/outline.ts:27
march?numberSpeed of the marching dashes, units per second. 0 keeps them still. Default 16.ui/outline.ts:33
padding?numberGap between the object and the frame, in outline units. Default 4.ui/outline.ts:29
stiffness?numberHow fast a glide reaches the new box, about 1 / seconds. Default 22.ui/outline.ts:47
ticker?Ticker | nullTicker that runs the animation and follows the targets. Default Ticker.shared. With null, call SelectionOutline.tick yourself.ui/outline.ts:49
transition?"pop" | "glide"What happens when the selection changes. pop (default): the old frame shrinks and fades away while the new one springs in. glide: one frame slides to the new box. Following the same objects while they move is always exact.ui/outline.ts:45