Rename should_propagate_event & add should_prevent_default#5779
Merged
emilk merged 2 commits intoemilk:masterfrom Mar 30, 2025
Merged
Rename should_propagate_event & add should_prevent_default#5779emilk merged 2 commits intoemilk:masterfrom
should_propagate_event & add should_prevent_default#5779emilk merged 2 commits intoemilk:masterfrom
Conversation
lucasmerlin
requested changes
Mar 13, 2025
lucasmerlin
added
web
|
Preview available at https://egui-pr-preview.github.io/pr/5779-propagate-events |
For consistency with the newly introduced `should_prevent_default`.
emilk
changed the title
prevent_default behaviorshould_propagate_event & add should_prevent_default
darkwater
pushed a commit
to darkwater/egui
that referenced
this pull request
Aug 24, 2025
…#5779) * [x] I have followed the instructions in the PR template Currently eframe [calls `prevent_default()`](https://github.com/emilk/egui/blob/962c7c75166dff3369d20675bcfd527d3287149f/crates/eframe/src/web/events.rs#L307-L369) for all copy / paste events on the [*document*](https://github.com/emilk/egui/blob/962c7c75166dff3369d20675bcfd527d3287149f/crates/eframe/src/web/events.rs#L88), making embedding an egui application in a page (e.g. an react application) hard (as all copy & paste functionality for other elements on the page is broken by this). I'm not sure what the motivation for this is, if any. This commit / PR adds a callback (`should_prevent_default`), similar to `should_propgate_event`, that an egui application can use to overwrite this behavior. It defaults to returning `true` for all events, to keep the existing behavior. I call `should_prevent_default` in every place that `should_propagate_event` is called (which is not all places that `prevent_default` is called!). I'm not sure for the motivation of not calling `should_propagate_event` everywhere that `stop_propagation` is called, but I kept that behavior for the `should_prevent_default` callback too. Please let me know if I'm missing some existing functionality that would allow me to do this, or if there's a reason that we don't want applications to be able to customize this (i.e. if there's a reason to always `prevent_default` for all copy / paste events on the whole document)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
WebOptions::should_propagate_eventtoshould_stop_propagationWebOptions:: should_prevent_defaultDetails
Currently eframe calls
prevent_default()for all copy / paste events on the document, making embedding an egui application in a page (e.g. an react application) hard (as all copy & paste functionality for other elements on the page is broken by this).I'm not sure what the motivation for this is, if any.
This commit / PR adds a callback (
should_prevent_default), similar toshould_propgate_event, that an egui application can use to overwrite this behavior. It defaults to returningtruefor all events, to keep the existing behavior.I call
should_prevent_defaultin every place thatshould_propagate_eventis called (which is not all places thatprevent_defaultis called!). I'm not sure for the motivation of not callingshould_propagate_eventeverywhere thatstop_propagationis called, but I kept that behavior for theshould_prevent_defaultcallback too.Please let me know if I'm missing some existing functionality that would allow me to do this, or if there's a reason that we don't want applications to be able to customize this (i.e. if there's a reason to always
prevent_defaultfor all copy / paste events on the whole document)