SmartContainerOptions
import type { SmartContainerOptions } from 'pixi-silk/ui/layout';Options of SmartContainer.
Extends#
Properties#
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
breakpoints? | readonly Breakpoint[] | Named records tested before portrait and landscape. | - | ui/layout/smart-container.ts:95 |
landscapeData? | LayoutData | The record for any other window. | - | ui/layout/smart-container.ts:93 |
layout? | SmartLayout | The container’s own flex style: direction, gap, padding and so on. | FlexContainerOptions.layout | ui/layout/flex-container.ts:66 |
onLayout? | (container: FlexContainer) => void | Called after every layout pass, on the container that ran it. | FlexContainerOptions.onLayout | ui/layout/flex-container.ts:72 |
portraitData? | LayoutData | The record for a window taller than wide. | - | ui/layout/smart-container.ts:91 |
safeArea? | Insets | Keeps boxes clear of these window insets, unless a record sets ignoreSafeArea. | - | ui/layout/smart-container.ts:99 |
switchTransition? | | boolean | { damping?: number; stiffness?: number; } | Glide to the new place and scale when the breakpoint changes. Pass an object to tune the spring. Default false. | - | ui/layout/smart-container.ts:101 |
ticker? | Ticker | null | ticker defaults to Ticker.shared. Pass null to call FlexContainer.tick yourself. | FlexContainerOptions.ticker | ui/layout/flex-container.ts:74 |
transition? | | boolean | { damping?: number; stiffness?: number; } | Glide children to new slots on a spring. true uses stiffness 170 and damping 26. Default false. | FlexContainerOptions.transition | ui/layout/flex-container.ts:68 |
viewport? | ViewportSource | The window to follow. Without one the container does not place itself. Set it later with SmartContainer.setViewport. | - | ui/layout/smart-container.ts:97 |
visible? | boolean | Initial visible of the container. Default true. | - | ui/layout/smart-container.ts:103 |
watch? | boolean | Checks the children’s bounds every frame and lays out again when they change. Default false. | FlexContainerOptions.watch | ui/layout/flex-container.ts:70 |