Close ModalScreen on click outside modal content

[TomJGooding]

You might sometimes want to close a ModalScreen by simply clicking outside the modal content (i.e. the darkened background).

I couldn't find anything in the docs or other discussions, so just sharing this in case it helps someone.

Please let me know if there is a better way!

    def on_click(self, event: events.Click) -> None:
        clicked, _ = self.get_widget_at(event.screen_x, event.screen_y)
        # Close the screen if the user clicks outside the modal content
        # (i.e. the darkened background)
        if clicked is self:
            self.app.pop_screen()

[davep]

Please let me know if there is a better way!

Me too.

[TomJGooding]

Thanks Dave, I thought I'd done a pretty thorough search for other examples but somehow missed that one!

[davep]

Easily missed though, hardly a standout example. I did write another example some time ago but I suspect that was as an illustration for someone on the Textualize Discord server: https://github.com/davep/textual-sandbox/blob/main/attic/click_outside_modal.py

[willmcgugan]

Looks like a solid solution to me!