Skip to main content

Interface: CreateToggleRequiredOptions

Defined in: ui/utilities/create-toggle.ts:29

Fields of CreateToggleOptions with no sensible default; callers must always provide these.

Properties​

checkmarkSprite​

checkmarkSprite: SpriteEcsComponent

Defined in: ui/utilities/create-toggle.ts:39

The sprite to draw the checkmark with, shown only while the toggle is on. A child panel, sized to exactly fill the box (see createPanel's stretchAll behavior) - use a checkmark image with transparent padding if it shouldn't cover the box edge-to-edge.


sprite​

sprite: SpriteEcsComponent

Defined in: ui/utilities/create-toggle.ts:31

The sprite to draw the toggle's box with, e.g. from createImageSprite.