wijjit.core.overlay.Overlay

class wijjit.core.overlay.Overlay(element, layer_type, z_index, close_on_click_outside=True, close_on_escape=True, trap_focus=False, on_close=None, dimmed_background=False, previous_focus=None, previous_focus_state=None)[source]

Represents a UI overlay (modal, dropdown, tooltip, etc.).

Parameters:

  • element (Element) – The element to render as an overlay

  • layer_type (LayerType) – Which layer this overlay belongs to

  • z_index (int) – Computed z-index (layer_base + stack_position)

  • close_on_click_outside (bool) – Whether clicking outside closes this overlay

  • close_on_escape (bool) – Whether ESC key closes this overlay

  • trap_focus (bool) – Whether to trap focus within this overlay

  • on_close (Callable or None) – Callback when overlay is closed

  • dimmed_background (bool) – Whether to dim the background behind this overlay

  • previous_focus (Element or None) – Element that had focus before this overlay opened

  • previous_focus_state (tuple or None) – Saved focus manager state (elements list, current index)

__init__(element, layer_type, z_index, close_on_click_outside=True, close_on_escape=True, trap_focus=False, on_close=None, dimmed_background=False, previous_focus=None, previous_focus_state=None)
Parameters:
Return type:

None

Methods

__init__(element, layer_type, z_index[, ...])

Attributes

close_on_click_outside

close_on_escape

dimmed_background

on_close

previous_focus

previous_focus_state

trap_focus

element

layer_type

z_index

element: Element
layer_type: LayerType
z_index: int
close_on_click_outside: bool = True
close_on_escape: bool = True
trap_focus: bool = False
on_close: Callable[[], None] | None = None
dimmed_background: bool = False
previous_focus: Element | None = None
previous_focus_state: tuple[Any, ...] | None = None