ConsumeInputProps

Defined in: ui/src/types.ts:197

Per-component opt-out for the UI auto-consume pointer fallback.

Every UI primitive (UIButton, UICheckbox, UIPanel, UIImage, UINineSlice, UIProgressBar, UIText) marks its underlying Pixi container so that pointerdown events landing on it (or any descendant) are auto-claimed by @yagejs/input via the renderer’s hit-test fallback — preventing taps on UI from also firing gameplay actions like MouseLeft.

Set consumeInput: false on a specific element to make it transparent to the action map: pointer events still fire its own handlers (e.g. an onClick callback) but also propagate to gameplay actions. Useful for cosmetic overlays (decorative HUD borders, full-screen filters) that should not block clicks on the world behind them.

Extended by

• UITextProps
• UIButtonProps
• UIImageProps
• UINineSliceProps
• UIProgressBarProps
• UICheckboxProps
• PanelProps
• ScrollViewProps
• PixiFancyButtonProps
• PixiCheckboxProps
• PixiProgressBarProps
• PixiSliderProps
• PixiInputProps
• PixiSelectProps
• PixiRadioGroupProps

Properties

consumeInput?

optional consumeInput?: boolean

Defined in: ui/src/types.ts:198