Crate bevy_input_focus 

A UI-centric focus system for Bevy.

This crate provides a system for managing input focus in Bevy applications, including:

• InputFocus, a resource for tracking which entity has input focus.
• Methods for getting and setting input focus via InputFocus and IsFocusedHelper.
• Events for when entities gain or lose focus: FocusGained and FocusLost.
• A generic FocusedInput event to send input events which bubble up from the focused entity.
• Various navigation frameworks for moving input focus between entities based on user input, such as tab_navigation and directional_navigation.

This crate does not provide any integration with UI widgets: this is the responsibility of the widget crate, which should depend on bevy_input_focus.

Modules

directional_navigation

A manual navigation framework for moving between focusable elements based on directional input.

navigator

Functions used by navigators to determine where to go next.

tab_navigation

This module provides a framework for handling linear tab-key navigation in Bevy applications.

Structs

AcquireFocus

An event which is used to set input focus. Trigger this on an entity, and it will bubble until it finds a focusable entity, and then set focus to it.

AutoFocus

Indicates that this widget should automatically receive InputFocus.

FocusGained

An EntityEvent that is sent when an entity gains InputFocus.

FocusLost

An EntityEvent that is sent when an entity loses InputFocus.

FocusedInput

A bubble-able user input event that starts at the currently focused entity.

InputDispatchPlugin

Plugin which sets up systems for dispatching bubbling keyboard and gamepad button events to the focused entity.

InputFocus

Resource representing which entity has input focus, if any. Input events (other than pointer-like inputs) will be dispatched to the current focus entity, or to the primary window if no entity has focus.

InputFocusPlugin

Plugin which sets up the core input focus system.

InputFocusVisible

Resource representing whether the input focus indicator should be visible on UI elements.

IsFocusedHelper

A system param that helps get information about the current focused entity.

WindowTraversal

These are for accessing components defined on the targeted entity

WindowTraversalItem

Automatically generated WorldQuery item type for WindowTraversal, returned when iterating over query results.

Enums

FocusCause

The cause for a FocusGained

InputFocusSystems

System sets for bevy_input_focus.

Traits

IsFocused

Trait which defines methods to check if an entity currently has focus.

Functions

dispatch_focused_input

System which dispatches bubbled input events to the focused entity, or to the primary window if no entity has focus.

process_recorded_focus_changes

Reads the recorded focus changes from the InputFocus resource and sends the appropriate FocusGained and FocusLost events.

set_initial_focus

If no entity is focused, sets the focus to the primary window, if any.