Align the behavior of the ui feature with egui (#477)

* Make `ui` and `egui` features behave the same way

* README.md

* RELEASES.md

* Document

* RELEASES.md

* Document

* CI

* typo

Cargo.toml

@@ -18,18 +18,19 @@ opt-level = 3
 members = ["./", "tools/ci", "macros"]
 
 [features]
-default = ['asset', 'ui', 'block_ui_interactions']
+default = ['asset', 'ui']
 
 # Allow using the `InputMap` as `bevy::asset::Asset`.
 asset = ['bevy/bevy_asset']
 
 # Add support for 'bevy::ui' integration:
+# - Allow 'bevy::ui' to take priority over actions when processing inputs.
 # - Automatic process clicks on 'bevy::ui' buttons that attached `ActionStateDriver` to drive corresponding actions.
 # - Allow using `MockUIInteraction` for 'bevy::ui' input mocking.
 ui = ['bevy/bevy_ui']
 
-# Allow 'bevy::ui' to take priority over actions when processing inputs.
-block_ui_interactions = []
+# Disable the priority of 'bevy::ui' when processing inputs.
+no_ui_priority = []
 
 # Add support for 'egui' integration:
 # - Allow 'egui' to take priority over actions when processing inputs.

README.md

@@ -111,5 +111,5 @@ This snippet is the `minimal.rs` example from the [`examples`](./examples) folde
 
 ## Crate Feature Flags
 
-This crate has four feature flags: `asset`, `ui`, `block_ui_interactions`, and `egui`.
+This crate has four feature flags: `asset`, `ui`, `no_ui_priority`, and `egui`.
 Please refer to the `[features]` section in the [`Cargo.toml`](./Cargo.toml) for detailed information about their configurations.

RELEASES.md

@@ -1,5 +1,13 @@
 # Release Notes
 
+## Unreleased
+
+### Breaking Changes
+
+- removed the `block_ui_interactions` feature:
+  - by default, this library will prioritize `bevy::ui`.
+  - if you want to disable this priority, add the newly added `no_ui_priority` feature to your configuration.
+
 ## Version 0.13.0
 
 ### Breaking Changes

src/systems.rs

@@ -72,9 +72,7 @@ pub fn update_action_state<A: Actionlike>(
     mut mouse_wheel: EventReader<MouseWheel>,
     mut mouse_motion: EventReader<MouseMotion>,
     clash_strategy: Res<ClashStrategy>,
-    #[cfg(all(feature = "ui", feature = "block_ui_interactions"))] interactions: Query<
-        &Interaction,
-    >,
+    #[cfg(all(feature = "ui", not(feature = "no_ui_priority")))] interactions: Query<&Interaction>,
     #[cfg(feature = "egui")] mut maybe_egui: Query<(Entity, &'static mut EguiContext)>,
     action_state: Option<ResMut<ActionState<A>>>,
     input_map: Option<Res<InputMap<A>>>,
@@ -91,7 +89,7 @@ pub fn update_action_state<A: Actionlike>(
     let mouse_motion: Vec<MouseMotion> = mouse_motion.read().cloned().collect();
 
     // If use clicks on a button, do not apply them to the game state
-    #[cfg(all(feature = "ui", feature = "block_ui_interactions"))]
+    #[cfg(all(feature = "ui", not(feature = "no_ui_priority")))]
     let (mouse_buttons, mouse_wheel) = if interactions
         .iter()
         .any(|&interaction| interaction != Interaction::None)

tools/ci/src/main.rs

@@ -78,7 +78,7 @@ fn main() {
     }
 
     // The features the lib offers
-    let lib_features = ["asset", "ui", "block_ui_interactions", "egui"];
+    let lib_features = ["asset", "ui", "no_ui_priority", "egui"];
 
     // Generate all possible combinations of lib features
     // and convert them into '--features=<FEATURE_A,FEATURE_B,...>'