floem/view/

id.rs

#![deny(missing_docs)]
//! # `ViewId`s
//!
//! [`ViewId`]s are unique identifiers for views.
//! They're used to identify views in the view tree.

use std::{any::Any, cell::RefCell, collections::HashSet, rc::Rc};

use floem_reactive::Scope;
use peniko::kurbo::{Affine, Point, Rect, RoundedRect, Size};
use smallvec::smallvec;
use taffy::{Layout, NodeId};
use winit::window::WindowId;

use ui_events::pointer::PointerId;

use super::{IntoView, StackOffset, VIEW_STORAGE, View, ViewState, ViewStorage};

thread_local! {
    /// Views that have scopes but couldn't find a parent scope when added.
    /// These need to be re-parented after the view tree is fully assembled.
    static PENDING_SCOPE_REPARENTS: RefCell<HashSet<ViewId>> = RefCell::new(HashSet::new());
}
use crate::context::EventCallbackConfig;
use crate::event::listener::EventListenerKey;
use crate::event::{RouteKind, listener};
use crate::style::recalc::StyleReason;
use crate::view::LayoutTree;
use crate::window::handle::get_current_view;
use crate::{BoxTree, ElementId, FocusNavMeta};
use crate::{
    ScreenLayout,
    action::add_update_message,
    animate::{AnimStateCommand, Animation},
    context::EventCallback,
    message::{
        CENTRAL_DEFERRED_UPDATE_MESSAGES, CENTRAL_UPDATE_MESSAGES, DeferredChild, DeferredChildren,
        DeferredReactiveSetup, UpdateMessage,
    },
    platform::menu::Menu,
    style::{Focusable, PointerEvents, Style, StyleClassRef, StyleSelector},
    window::tracking::window_id_for_root,
};

use super::AnyView;

#[allow(unused)]
pub struct NotThreadSafe(*const ());

/// A small unique identifier, and handle, for an instance of a [View](crate::View).
///
/// Through this handle, you can access the associated view [ViewState](crate::view_state::ViewState).
/// You can also use this handle to access the children ViewId's which allows you access to their states.
///
/// This type is not thread safe and can only be used from the main thread.
#[derive(Copy, Clone, Default, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[repr(transparent)]
pub struct ViewId(
    pub(crate) slotmap::KeyData,
    std::marker::PhantomData<NotThreadSafe>,
);
impl std::fmt::Debug for ViewId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let debug_name = self.debug_name();
        let mut start = f.debug_struct("ViewId");

        if !debug_name.is_empty() {
            start.field("id", &self.0).field("debug_name", &debug_name)
        } else {
            start.field("id", &self.0)
        }
        .finish()
    }
}
impl slotmap::__impl::From<slotmap::KeyData> for ViewId {
    fn from(k: slotmap::KeyData) -> Self {
        ViewId(k, std::marker::PhantomData)
    }
}
unsafe impl slotmap::Key for ViewId {
    fn data(&self) -> slotmap::KeyData {
        self.0
    }
}

fn request_structural_selector_restyle(children: &[ViewId]) {
    for child in children {
        child.request_style(StyleReason::full_recalc());
    }
}

impl ViewId {
    /// Create a new unique `Viewid`.
    pub fn new() -> ViewId {
        VIEW_STORAGE.with_borrow_mut(|s| {
            let root = get_current_view();
            let new = s.view_ids.insert(());
            s.root.insert(new, root);
            new
        })
    }

    pub(crate) fn new_root() -> ViewId {
        VIEW_STORAGE.with_borrow_mut(|s| {
            let new = s.view_ids.insert(());
            s.root.insert(new, new);
            new
        })
    }

    /// Get the chain of debug names that have been applied to this view.
    ///
    /// This uses try_borrow on the view state so if the view state has already been borrowed when using this method, it won't crash and it will just return an empty string.
    pub fn debug_name(&self) -> String {
        let state_names = self
            .state()
            .try_borrow()
            .ok()
            .map(|state| state.debug_name.iter().rev().cloned().collect::<Vec<_>>())
            .unwrap_or_default();

        let view_name = self
            .view()
            .try_borrow()
            .ok()
            .map(|view| View::debug_name(view.as_ref()).to_string())
            .unwrap_or_default();

        state_names
            .into_iter()
            .chain(std::iter::once(view_name))
            .collect::<Vec<_>>()
            .join(" - ")
    }

    /// Check if this ViewId is still valid (exists in VIEW_STORAGE).
    ///
    /// A ViewId becomes invalid when it has been removed from the view tree.
    /// This is useful for filtering out stale ViewIds from collections.
    pub fn is_valid(&self) -> bool {
        VIEW_STORAGE.with_borrow(|s| s.view_ids.contains_key(*self))
    }

    /// Remove this view id and all of its children from the `VIEW_STORAGE`.
    ///
    /// Note: For full cleanup including taffy nodes and cleanup listeners,
    /// use `window_state.remove_view()` or send an `UpdateMessage::RemoveViews`.
    pub fn remove(&self) {
        let element_id = self.get_element_id();
        // Dispose children scope if this view had reactive children
        if let Some(scope) = self.take_children_scope() {
            scope.dispose();
        }
        // Dispose keyed children scopes if this view had keyed reactive children
        if let Some(keyed_children) = self.take_keyed_children() {
            for (_child_id, scope) in keyed_children {
                scope.dispose();
            }
        }
        // Get parent before removing, for stacking cache invalidation
        let parent = self.parent();
        VIEW_STORAGE.with_borrow_mut(|s| {
            // remove the reverse mapping for taffy nodes
            let taffy_node = s.state(*self).borrow().layout_id;
            s.taffy_to_view.remove(&taffy_node);

            // Remove the cached root, in the (unlikely) case that this view is
            // re-added to a different window
            s.root.remove(*self);
            // Remove from overlays if registered
            s.overlays.remove(*self);
            // Remove self from parent's children list
            if let Some(Some(parent)) = s.parent.get(*self)
                && let Some(children) = s.children.get_mut(*parent)
            {
                children.retain(|c| c != self);
            }
            // Clean up all SecondaryMap entries for this view to prevent
            // stale data when slots are reused. SecondaryMaps don't auto-clean
            // when the primary SlotMap key is removed.
            s.children.remove(*self);
            s.parent.remove(*self);
            s.states.remove(*self);
            s.views.remove(*self);
            // Remove from primary SlotMap last
            s.view_ids.remove(*self);
        });
        // Invalidate this view and parent cache entries. During removal, using
        // explicit IDs avoids relying on storage lookups that may already be detached.
        let parent_element_id = parent.map(|p| p.get_element_id());
        {
            let _element_id = element_id;
            let _parent_element_id = parent_element_id;
            // Hit testing now uses Understory ordering directly and caches the result in event/path.rs.
            // Any stacking-affecting change must invalidate both caches together.
            crate::event::clear_hit_test_cache();
        };
    }

    /// Register this view as an overlay.
    ///
    /// Overlays escape z-index constraints and are painted at the root level,
    /// above all other views. The root is determined at registration time.
    pub(crate) fn register_overlay(&self) {
        let root_id = self.root();
        VIEW_STORAGE.with_borrow_mut(|s| {
            s.overlays.insert(*self, root_id);
            if let Some(logical_parent_id) = s.parent.get(*self).and_then(|p| *p) {
                let this_element_id = s.state(*self).borrow().element_id;
                let parent_element_id =
                    box_tree_parent_element_id_for_child(s, logical_parent_id, *self);
                s.box_tree(*self)
                    .borrow_mut()
                    .reparent(this_element_id.0, Some(parent_element_id.0));
            }
        });
    }

    /// Unregister this view as an overlay.
    #[expect(dead_code)] // Kept for API symmetry with register_overlay
    pub(crate) fn unregister_overlay(&self) {
        VIEW_STORAGE.with_borrow_mut(|s| {
            s.overlays.remove(*self);
            if let Some(logical_parent_id) = s.parent.get(*self).and_then(|p| *p) {
                let this_element_id = s.state(*self).borrow().element_id;
                let parent_element_id = s.state(logical_parent_id).borrow().element_id;
                s.box_tree(*self)
                    .borrow_mut()
                    .reparent(this_element_id.0, Some(parent_element_id.0));
            }
        });
    }

    /// Get access to the layout tree tree
    /// TODO: rename layout tree
    pub fn taffy(&self) -> Rc<RefCell<LayoutTree>> {
        VIEW_STORAGE.with_borrow_mut(|s| s.taffy.clone())
    }

    /// Get access to the box tree
    pub fn box_tree(&self) -> Rc<RefCell<BoxTree>> {
        VIEW_STORAGE.with_borrow_mut(|s| s.box_tree(*self))
    }

    /// Create a new taffy layout node
    pub fn new_taffy_node(&self) -> NodeId {
        self.taffy()
            .borrow_mut()
            .new_leaf(taffy::style::Style::DEFAULT)
            .unwrap()
    }

    /// Set the layout properties on a taffy node
    pub fn set_taffy_style(&self, node: NodeId, style: taffy::Style) {
        let _ = self.taffy().borrow_mut().set_style(node, style);
    }

    /// Get the layout for a taffy node relative to it's parent
    pub fn taffy_layout(&self, node: NodeId) -> Option<taffy::Layout> {
        self.taffy().borrow().layout(node).cloned().ok()
    }

    /// Mark the taffy node associated with this view as dirty.
    pub fn mark_view_layout_dirty(&self) -> taffy::TaffyResult<()> {
        let node = self.taffy_node();
        self.taffy().borrow_mut().mark_dirty(node)
    }
    /// Get the taffy node associated with this Id
    pub fn taffy_node(&self) -> NodeId {
        self.state().borrow().layout_id
    }

    /// set the transform on a view that is applied after style transforms
    pub fn set_transform(&self, transform: Affine) {
        self.state().borrow_mut().transform = transform;
        self.request_box_tree_update_for_view();
    }

    pub(crate) fn state(&self) -> Rc<RefCell<ViewState>> {
        VIEW_STORAGE.with_borrow_mut(|s| s.state(*self))
    }

    /// Get access to the View
    pub(crate) fn view(&self) -> Rc<RefCell<Box<dyn View>>> {
        VIEW_STORAGE.with_borrow(|s| {
            s.views.get(*self).cloned().unwrap_or_else(|| {
                // eprintln!("stale");
                s.stale_view.clone()
            })
        })
    }

    /// Add a child View to this Id's list of children
    pub fn add_child(&self, child: Box<dyn View>) {
        let child_id = child.id();
        let child_element_id = child_id.get_element_id();
        VIEW_STORAGE.with_borrow_mut(|s| {
            s.children.entry(*self).unwrap().or_default().push(child_id);
            s.parent.insert(child_id, Some(*self));
            s.views.insert(child_id, Rc::new(RefCell::new(child)));
            let parent_element_id = box_tree_parent_element_id_for_child(s, *self, child_id);
            s.box_tree(child_id)
                .borrow_mut()
                .reparent(child_element_id.0, Some(parent_element_id.0));
            let child_taffy_node = s.state(child_id).borrow().layout_id;
            let this_taffy_node = s.state(*self).borrow().layout_id;
            let _ = s
                .taffy
                .borrow_mut()
                .add_child(this_taffy_node, child_taffy_node);
        });
        // Re-parent child's scope under nearest ancestor's scope to match view hierarchy.
        // This ensures scope hierarchy matches view hierarchy for proper cleanup.
        reparent_scope_if_needed(child_id, *self);
        request_structural_selector_restyle(&self.children());
    }

    /// Append multiple children to this Id's list of children.
    ///
    /// This is more efficient than calling `add_child` multiple times
    /// as it only borrows VIEW_STORAGE once.
    ///
    /// Takes a `Vec` to ensure views are fully constructed before borrowing
    /// VIEW_STORAGE, avoiding potential borrow conflicts.
    pub fn append_children(&self, children: Vec<Box<dyn View>>) {
        let child_ids: Vec<ViewId> = children.iter().map(|c| c.id()).collect();
        VIEW_STORAGE.with_borrow_mut(|s| {
            let this_taffy_node = s.state(*self).borrow().layout_id;
            let child_element_ids: Vec<_> = children
                .iter()
                .map(|c| s.state(c.id()).borrow().element_id)
                .collect();
            let child_taffy_nodes: Vec<_> = children
                .iter()
                .map(|c| s.state(c.id()).borrow().layout_id)
                .collect();

            let box_tree = s.box_tree(*self);
            let layout_tree = s.taffy.clone();

            for ((child, child_element_id), child_taffy_node) in children
                .into_iter()
                .zip(child_element_ids)
                .zip(child_taffy_nodes)
            {
                let child_id = child.id();
                s.children.entry(*self).unwrap().or_default().push(child_id);
                s.parent.insert(child_id, Some(*self));
                s.views.insert(child_id, Rc::new(RefCell::new(child)));
                let parent_element_id = box_tree_parent_element_id_for_child(s, *self, child_id);
                box_tree
                    .borrow_mut()
                    .reparent(child_element_id.0, Some(parent_element_id.0));
                let _ = layout_tree
                    .borrow_mut()
                    .add_child(this_taffy_node, child_taffy_node);
            }
        });
        // Re-parent child scopes under nearest ancestor's scope
        for child_id in child_ids {
            reparent_scope_if_needed(child_id, *self);
        }
        request_structural_selector_restyle(&self.children());
    }

    /// Set the children views of this Id
    /// See also [`Self::set_children_vec`]
    pub fn set_children<const N: usize, V: IntoView>(&self, children: [V; N]) {
        let children_ids: Vec<ViewId> = VIEW_STORAGE.with_borrow_mut(|s| {
            let mut children_ids = Vec::new();
            let mut children_nodes = Vec::with_capacity(children.len());
            let box_tree = s.box_tree(*self);
            let layout_tree = s.taffy.clone();
            for child in children {
                let child_view = child.into_view();
                let child_view_id = child_view.id();
                let child_element_id = s.state(child_view_id).borrow().element_id;
                let child_taffy_node = s.state(child_view_id).borrow().layout_id;
                children_nodes.push(child_taffy_node);
                children_ids.push(child_view_id);
                s.parent.insert(child_view_id, Some(*self));
                s.views
                    .insert(child_view_id, Rc::new(RefCell::new(child_view.into_any())));
                let parent_element_id =
                    box_tree_parent_element_id_for_child(s, *self, child_view_id);

                box_tree
                    .borrow_mut()
                    .reparent(child_element_id.0, Some(parent_element_id.0));
            }
            s.children.insert(*self, children_ids.clone());
            let this_taffy_node = s.state(*self).borrow().layout_id;
            let _ = layout_tree
                .borrow_mut()
                .set_children(this_taffy_node, &children_nodes);
            children_ids
        });
        // Re-parent child scopes under nearest ancestor's scope
        for child_id in children_ids {
            reparent_scope_if_needed(child_id, *self);
        }
        request_structural_selector_restyle(&self.children());
    }

    /// Set the children views of this Id using a Vector
    /// See also [`Self::set_children`] and [`Self::set_children_iter`]
    pub fn set_children_vec(&self, children: Vec<impl IntoView>) {
        self.set_children_iter(children.into_iter().map(|c| c.into_any()));
    }

    /// Set the children views of this Id using an iterator of boxed views.
    ///
    /// This is the most efficient way to set children when you already have
    /// an iterator of `Box<dyn View>`, as it avoids intermediate allocations.
    ///
    /// See also [`Self::set_children`] and [`Self::set_children_vec`]
    pub fn set_children_iter(&self, children: impl Iterator<Item = Box<dyn View>>) {
        let children_ids: Vec<ViewId> = VIEW_STORAGE.with_borrow_mut(|s| {
            let mut children_ids = Vec::new();
            let mut children_nodes = Vec::new();
            let box_tree = s.box_tree(*self);
            let layout_tree = s.taffy.clone();
            for child_view in children {
                let child_view_id = child_view.id();
                let child_element_id = s.state(child_view_id).borrow().element_id;
                let child_taffy_node = s.state(child_view_id).borrow().layout_id;
                children_ids.push(child_view_id);
                children_nodes.push(child_taffy_node);
                s.parent.insert(child_view_id, Some(*self));
                s.views
                    .insert(child_view_id, Rc::new(RefCell::new(child_view)));
                let parent_element_id =
                    box_tree_parent_element_id_for_child(s, *self, child_view_id);
                box_tree
                    .borrow_mut()
                    .reparent(child_element_id.0, Some(parent_element_id.0));
            }
            s.children.insert(*self, children_ids.clone());
            let this_taffy_node = s.state(*self).borrow().layout_id;
            let _ = layout_tree
                .borrow_mut()
                .set_children(this_taffy_node, &children_nodes);
            children_ids
        });
        // Re-parent child scopes under nearest ancestor's scope
        for child_id in children_ids {
            reparent_scope_if_needed(child_id, *self);
        }
        request_structural_selector_restyle(&self.children());
    }

    /// Set the view that should be associated with this Id
    pub fn set_view(&self, view: Box<dyn View>) {
        VIEW_STORAGE.with_borrow_mut(|s| {
            if s.view_ids.contains_key(*self) {
                s.views.insert(*self, Rc::new(RefCell::new(view)));
            }
        });
    }

    /// Set the Id that should be used as the parent of this Id
    pub fn set_parent(&self, parent: ViewId) {
        VIEW_STORAGE.with_borrow_mut(|s| {
            if s.view_ids.contains_key(*self) {
                let this_element_id = s.state(*self).borrow().element_id;
                s.parent.insert(*self, Some(parent));
                let parent_element_id = box_tree_parent_element_id_for_child(s, parent, *self);
                let box_tree = s.box_tree(*self);
                box_tree
                    .borrow_mut()
                    .reparent(this_element_id.0, Some(parent_element_id.0));
            }
        });
    }

    /// Set the Ids that should be used as the children of this Id
    pub fn set_children_ids(&self, children: Vec<ViewId>) {
        VIEW_STORAGE.with_borrow_mut(|s| {
            if !s.view_ids.contains_key(*self) {
                return;
            }

            let this_taffy_node = s.state(*self).borrow().layout_id;

            let child_element_ids: Vec<_> = children
                .iter()
                .map(|&child_id| s.state(child_id).borrow().element_id)
                .collect();
            let taffy_children: Vec<_> = children
                .iter()
                .map(|&child_id| s.state(child_id).borrow().layout_id)
                .collect();

            let box_tree = s.box_tree(*self);
            let layout_tree = s.taffy.clone();
            for (&child_id, child_element_id) in children.iter().zip(child_element_ids) {
                s.parent.insert(child_id, Some(*self));
                let parent_element_id = box_tree_parent_element_id_for_child(s, *self, child_id);
                box_tree
                    .borrow_mut()
                    .reparent(child_element_id.0, Some(parent_element_id.0));
            }

            let _ = layout_tree
                .borrow_mut()
                .set_children(this_taffy_node, &taffy_children);
            s.children.insert(*self, children);
        });
        request_structural_selector_restyle(&self.children());
    }

    /// Get the list of `ViewId`s that are associated with the children views of this `ViewId`
    pub fn children(&self) -> Vec<ViewId> {
        VIEW_STORAGE.with_borrow(|s| s.children.get(*self).cloned().unwrap_or_default())
    }

    /// Get access to the list of `ViewId`s that are associated with the children views of this `ViewId`
    pub fn with_children<R>(&self, mut children: impl FnMut(&[ViewId]) -> R) -> R {
        VIEW_STORAGE.with_borrow(|s| children(s.children.get(*self).map_or(&[], |v| v)))
    }

    /// Get the `ViewId` that has been set as this `ViewId`'s parent
    pub fn parent(&self) -> Option<ViewId> {
        VIEW_STORAGE.with_borrow(|s| s.parent.get(*self).cloned().flatten())
    }

    /// Get the root view of the window that the given view is in
    pub fn root(&self) -> ViewId {
        VIEW_STORAGE.with_borrow(|s| {
            *s.root.get(*self).expect(
                "all view ids are entered into the root map and have a root id upon creation",
            )
        })
    }

    /// try to get the root. use this if it is possible that the view has been deleted
    pub(crate) fn try_root(&self) -> Option<ViewId> {
        VIEW_STORAGE.with_borrow(|s| s.root.get(*self).copied())
    }

    /// Get the size of this View
    pub fn get_size(&self) -> Option<Size> {
        self.get_layout()
            .map(|l| Size::new(l.size.width as f64, l.size.height as f64))
    }

    /// Get the Size of the parent View
    pub fn parent_size(&self) -> Option<Size> {
        let parent_id = self.parent()?;
        parent_id.get_size()
    }

    /// Get the total scroll offset for this view
    pub fn get_scroll_cx(&self) -> peniko::kurbo::Vec2 {
        self.state().borrow().scroll_cx
    }

    /// This gets the Taffy Layout and adjusts it to be relative to the parent `View`.
    pub fn get_layout(&self) -> Option<Layout> {
        let widget_parent = self.parent().map(|id| id.state().borrow().layout_id);

        let taffy = self.taffy();
        let mut node = self.state().borrow().layout_id;
        let mut layout = *taffy.borrow().layout(node).ok()?;

        loop {
            let parent = taffy.borrow().parent(node);

            if parent == widget_parent {
                break;
            }

            node = parent?;

            layout.location = layout.location + taffy.borrow().layout(node).ok()?.location;
        }

        Some(layout)
    }

    /// Returns the [`Visualid`] associated with this view.
    ///
    /// This id can be used with the box tree.
    pub fn get_element_id(&self) -> ElementId {
        self.state().borrow().element_id
    }

    /// Returns the complete local-to-window coordinate transform.
    ///
    /// This transform converts coordinates from this view's local space to window
    /// coordinates. It combines:
    /// - The view's position in the window
    /// - Any CSS transforms (scale, rotate)
    ///
    /// To convert a local point to window coordinates: `visual_transform * point`
    /// To convert a window point to local coordinates: `visual_transform.inverse() * point`
    ///
    /// This is the transform used by event dispatch to convert pointer coordinates.
    pub fn get_visual_transform(&self) -> peniko::kurbo::Affine {
        let element_id = self.get_element_id();
        VIEW_STORAGE.with_borrow_mut(|s| {
            s.box_tree(*self)
                .borrow_mut()
                .get_or_compute_world_transform(element_id.0)
                .unwrap_or_default()
        })
    }

    /// Return the world-space axis-aligned bounding box for this view.
    ///
    /// This is the loose AABB computed after applying local transforms and any active clips.
    /// It fully contains the transformed bounds but may not be tight, especially under rotation
    /// or rounded clips.
    pub fn get_visual_rect(&self) -> Rect {
        let element_id = self.get_element_id();
        VIEW_STORAGE.with_borrow_mut(|s| {
            s.box_tree(*self)
                .borrow_mut()
                .get_or_compute_world_bounds(element_id.0)
                .unwrap_or_default()
        })
    }

    /// Return the local bounds in world coordinate space
    pub fn get_visual_rect_no_clip(&self) -> Rect {
        let element_id = self.get_element_id();
        let transform = self.get_visual_transform();
        VIEW_STORAGE.with_borrow_mut(|s| {
            let box_tree = s.box_tree(*self);

            transform.transform_rect_bbox(
                box_tree
                    .borrow()
                    .local_bounds(element_id.0)
                    .unwrap_or_default(),
            )
        })
    }

    /// Returns the view's visual position (after applying all clips clips and css transforms) in window coordinates.
    pub fn get_visual_origin(&self) -> peniko::kurbo::Point {
        let element_id = self.get_element_id();
        VIEW_STORAGE
            .with_borrow_mut(|s| {
                s.box_tree(*self)
                    .borrow_mut()
                    .get_or_compute_world_bounds(element_id.0)
                    .unwrap_or_default()
            })
            .origin()
    }

    /// Returns the layout rect relative to the parent view.
    ///
    /// The position is relative to the parent view's origin. This is the raw layout
    /// as computed by Taffy, useful for measuring and positioning views within their
    /// parent's coordinate space.
    pub fn get_layout_rect(&self) -> Rect {
        self.get_layout()
            .map(|l| Rect {
                x0: f64::from(l.location.x),
                y0: f64::from(l.location.y),
                x1: f64::from(l.location.x + l.size.width),
                y1: f64::from(l.location.y + l.size.height),
            })
            .unwrap_or_default()
    }

    /// Returns the content rect relative to the parent view.
    ///
    /// The content rect excludes borders and padding, representing the area where
    /// content is positioned. The position is relative to the parent view's
    /// origin.
    pub fn get_content_rect(&self) -> Rect {
        self.get_layout()
            .map(|l| Rect {
                x0: f64::from(l.content_box_x()),
                y0: f64::from(l.content_box_y()),
                x1: f64::from(l.content_box_x() + l.content_box_width()),
                y1: f64::from(l.content_box_y() + l.content_box_height()),
            })
            .unwrap_or_default()
    }

    /// Returns the layout rect in the view's local coordinate space.
    pub fn get_layout_rect_local(&self) -> Rect {
        self.get_layout()
            .map(|l| Rect {
                x0: 0.0,
                y0: 0.0,
                x1: f64::from(l.size.width),
                y1: f64::from(l.size.height),
            })
            .unwrap_or_default()
    }

    /// Returns the content rect in the view's local coordinate space.
    ///
    /// The content rect excludes borders and padding, representing the area where
    /// child content should be positioned. This is in the view's local coordinate
    /// space, with an offset that accounts for borders and padding.
    ///
    /// Like `layout_rect_local()`, this is in the same coordinate space as events
    /// transformed via `window_event_to_view()`.
    pub fn get_content_rect_local(&self) -> Rect {
        self.get_layout()
            .map(|r| {
                let x0 = f64::from(r.border.left + r.padding.left);
                let y0 = f64::from(r.border.top + r.padding.top);
                let x1 = x0 + f64::from(r.content_box_width());
                let y1 = y0 + f64::from(r.content_box_height());
                Rect { x0, y0, x1, y1 }
            })
            .unwrap_or_default()
    }

    /// Returns the content rect of a child layout node, relative to the parent layout node's origin.
    ///
    /// This walks up the Taffy layout tree from `child_node` to `parent_node`, accumulating
    /// the positions to compute the final relative content rect.
    ///
    /// Returns `None` if either node doesn't exist or if `child_node` is not a descendant of `parent_node`.
    pub fn get_content_rect_relative(
        &self,
        child_node: taffy::NodeId,
        parent_node: taffy::NodeId,
    ) -> Option<Rect> {
        let taffy = self.taffy();
        let taffy = taffy.borrow();
        let mut node = child_node;
        let mut child_layout = *taffy.layout(node).ok()?;

        // Accumulate position offsets from child up to parent
        loop {
            let current_parent = taffy.parent(node);

            if current_parent == Some(parent_node) {
                break;
            }

            node = current_parent?;
            child_layout.location = child_layout.location + taffy.layout(node).ok()?.location;
        }

        // Build the content rect relative to the parent
        Some(Rect::from_origin_size(
            (
                f64::from(child_layout.content_box_x()),
                f64::from(child_layout.content_box_y()),
            ),
            (
                f64::from(child_layout.content_box_width()),
                f64::from(child_layout.content_box_height()),
            ),
        ))
    }

    /// Set a translation that will affect children.
    ///
    /// If you have a view that visually affects how far children should scroll, set it here.
    pub fn set_child_translation(&self, child_translation: peniko::kurbo::Vec2) -> bool {
        let state = self.state();
        let needs_box_tree_update = {
            let mut state = state.borrow_mut();
            if state.child_translation != child_translation {
                state.child_translation = child_translation;
                true
            } else {
                false
            }
        };
        if needs_box_tree_update {
            for child in self.children() {
                child.request_box_tree_update_for_view();
            }
        }
        needs_box_tree_update
    }

    /// Get the translation that affects children
    pub fn get_child_translation(&self) -> peniko::kurbo::Vec2 {
        self.state().borrow().child_translation
    }

    /// set the clip rectange in local coordinates in the box tree
    pub fn set_box_tree_clip(&self, clip: Option<RoundedRect>) {
        let element_id = self.get_element_id();
        VIEW_STORAGE.with_borrow_mut(|s| {
            let box_tree = s.box_tree(*self);
            box_tree.borrow_mut().set_local_clip(element_id.0, clip)
        })
    }

    /// Returns true if this view is hidden.
    pub fn is_hidden(&self) -> bool {
        let state = self.state();
        let state = state.borrow();
        state.visibility.is_hidden()
    }

    /// if the view has pointer events none
    pub fn pointer_events_none(&self) -> bool {
        let state = self.state();
        let state = state.borrow();
        state
            .computed_style
            .builtin()
            .pointer_events()
            .map(|p| p == PointerEvents::None)
            .unwrap_or(false)
    }

    /// Returns true if the view is disabled
    ///
    /// This is done by checking if the style for this view has `Disabled` set to true.
    pub fn is_disabled(&self) -> bool {
        self.state().borrow_mut().style_interaction_cx.disabled
    }

    /// Returns true if the view is selected
    ///
    /// This is done by checking if the parent has set this view as selected
    /// via `parent_set_selected()`.
    pub fn is_selected(&self) -> bool {
        self.state().borrow().parent_set_style_interaction.selected
    }

    /// Check if this id can be focused.
    ///
    /// This is done by checking if the style for this view has `Focusable` set to `Focus::PointerAndProgramatic` or `Focus::KeyboardNavigable`.
    pub fn can_focus(&self) -> bool {
        self.state()
            .borrow()
            .computed_style
            .get(Focusable)
            .is_focusable()
    }

    /// Request that this the `id` view be styled, laid out and painted again.
    /// This will recursively request this for all parents.
    pub fn request_all(&self) {
        add_update_message(UpdateMessage::RequestStyle(
            self.get_element_id(),
            StyleReason::full_recalc(),
        ));
        self.request_layout();
        self.request_box_tree_commit();
        self.add_update_message(UpdateMessage::RequestPaint);
    }

    /// Request that this view have it's layout pass run
    pub fn request_layout(&self) {
        add_update_message(UpdateMessage::RequestLayout);
    }

    /// Request that this view have it's taffy node be marked dirty
    pub fn request_mark_view_layout_dirty(&self) {
        add_update_message(UpdateMessage::MarkViewLayoutDirty(*self));
    }

    /// Request that the box tree be updated from the layout tree (full walk) and committed.
    /// Use this after layout changes that affect the entire tree.
    pub fn request_box_tree_update(&self) {
        add_update_message(UpdateMessage::RequestBoxTreeUpdate);
    }

    /// Request that this specific view's box tree node be updated and committed.
    /// This is more efficient than a full tree update when only this view changed
    /// (e.g., after a transform or scroll offset change).
    pub fn request_box_tree_update_for_view(&self) {
        add_update_message(UpdateMessage::RequestBoxTreeUpdateForView(*self));
    }

    /// Request that the box tree be committed without updating from layout.
    /// Use this when you've manually updated box tree nodes and just need to commit.
    pub fn request_box_tree_commit(&self) {
        add_update_message(UpdateMessage::RequestBoxTreeCommit);
    }

    /// Get the window id of the window containing this view, if there is one.
    pub fn window_id(&self) -> Option<WindowId> {
        window_id_for_root(self.root())
    }

    /// Request that this view have it's paint pass run
    pub fn request_paint(&self) {
        self.add_update_message(UpdateMessage::RequestPaint);
    }

    /// request that this node be styled again
    pub fn request_style(&self, reason: StyleReason) {
        self.add_update_message(UpdateMessage::RequestStyle(self.get_element_id(), reason));
    }

    /// Use this when you want the `view_style` method from the `View` trait to be rerun.
    ///
    // TODO: Add this to style reason set
    #[deprecated(note = "use `id.request_style(StyleReasonSet::view_style())` directly instead")]
    pub fn request_view_style(&self) {
        self.request_style(StyleReason::view_style());
    }

    /// Request that this view gain the window focus
    pub fn request_focus(&self) {
        self.add_update_message(UpdateMessage::Focus(self.get_element_id()));
    }

    /// Clear the focus from this window
    pub fn clear_focus(&self) {
        self.add_update_message(UpdateMessage::ClearFocus);
    }

    /// Set the system context menu that should be shown when this view is right-clicked
    pub fn update_context_menu(&self, menu: impl Fn() -> Menu + 'static) {
        self.state().borrow_mut().context_menu = Some(Rc::new(menu));
    }

    /// Set the system popout menu that should be shown when this view is clicked
    ///
    /// Adds a primary-click context menu, which opens below the view.
    pub fn update_popout_menu(&self, menu: impl Fn() -> Menu + 'static) {
        self.state().borrow_mut().popout_menu = Some(Rc::new(menu));
    }

    // =========================================================================
    // Pointer Capture API (W3C Pointer Events)
    // =========================================================================
    //

    /// Set pointer capture for this view.
    ///
    /// When a view has pointer capture for a pointer, all subsequent pointer events
    /// for that pointer are dispatched directly to this view, regardless of where
    /// the pointer moves. This is useful for:
    /// - Drag operations that should continue even when the pointer leaves the view
    /// - Sliders and scrollbars that need to track pointer movement globally
    /// - Any interaction that requires reliable pointer tracking
    ///
    /// The capture will be applied on the next pointer event for this pointer ID.
    /// When capture is set:
    /// - `GainedPointerCapture` event is fired to this view
    /// - All subsequent pointer events for this pointer are routed here
    /// - When released, `LostPointerCapture` event is fired
    ///
    /// Capture is automatically released on `PointerUp` for the captured pointer.
    ///
    /// # Example
    /// ```ignore
    /// fn event_before_children(&mut self, cx: &mut EventCx, event: &Event) -> EventPropagation {
    ///     if let Event::Pointer(PointerEvent::Down(e)) = event {
    ///         if let Some(pointer_id) = e.pointer.pointer_id {
    ///             self.id().set_pointer_capture(pointer_id);
    ///         }
    ///     }
    ///     EventPropagation::Continue
    /// }
    /// ```
    pub fn set_pointer_capture(&self, pointer_id: PointerId) {
        self.add_update_message(UpdateMessage::SetPointerCapture {
            element_id: self.get_element_id(),
            pointer_id,
        });
    }

    /// Release pointer capture from this view.
    ///
    /// If this view has capture for the specified pointer, the capture will be
    /// released on the next pointer event. A `LostPointerCapture` event will be
    /// fired when the release takes effect.
    ///
    /// Note: This only releases capture if this view currently has it.
    /// It's safe to call even if this view doesn't have capture.
    pub fn release_pointer_capture(&self, pointer_id: PointerId) {
        self.add_update_message(UpdateMessage::ReleasePointerCapture {
            element_id: self.get_element_id(),
            pointer_id,
        });
    }

    /// Send a message to the application to open the Inspector for this Window
    pub fn inspect(&self) {
        self.add_update_message(UpdateMessage::Inspect);
    }

    /// Scrolls the view and all direct and indirect children to bring the view to be
    /// visible. The optional rectangle can be used to add an additional offset and intersection.
    pub fn scroll_to(&self, rect: Option<Rect>) {
        self.add_update_message(UpdateMessage::ScrollTo {
            id: self.get_element_id(),
            rect,
        });
    }

    pub(crate) fn transition_anim_complete(&self) {
        self.add_update_message(UpdateMessage::ViewTransitionAnimComplete(*self));
    }

    pub(crate) fn update_animation(&self, offset: StackOffset<Animation>, animation: Animation) {
        let state = self.state();
        state.borrow_mut().animations.set(offset, animation);
        self.request_style(StyleReason::animation());
    }

    pub(crate) fn update_animation_state(
        &self,
        offset: StackOffset<Animation>,
        command: AnimStateCommand,
    ) {
        let view_state = self.state();
        view_state
            .borrow_mut()
            .animations
            .update(offset, move |anim| anim.transition(command));
        self.request_style(StyleReason::animation());
    }

    /// Send a state update to the `update` method of the associated View
    pub fn update_state(&self, state: impl Any) {
        self.add_update_message(UpdateMessage::State {
            id: *self,
            state: Box::new(state),
        });
    }

    /// Add an callback on an action for a given `EventListener`
    pub(crate) fn add_event_listener(
        &self,
        listener: EventListenerKey,
        action: Box<EventCallback>,
        config: EventCallbackConfig,
    ) {
        add_update_message(crate::message::UpdateMessage::RegisterListener(
            listener, *self,
        ));
        let state = self.state();
        state
            .borrow_mut()
            .add_event_listener(listener, action, config);
    }

    /// Set a callback that should be run when the view is removed from the view tree
    pub fn add_cleanup_listener(&self, action: Rc<dyn Fn()>) {
        let state = self.state();
        state.borrow_mut().add_cleanup_listener(action);
    }

    /// Get the resolved style for this view (base + selectors + classes).
    ///
    /// This contains all style properties explicitly set on this view, including
    /// properties from applied classes and resolved selectors. It does NOT include
    /// inherited properties from ancestor views (like font_size, color, etc.).
    ///
    /// ## When to use
    /// Use `combined_style` when you need to know what this specific view defines:
    /// - Checking if THIS view explicitly sets a property
    /// - Computing what should propagate to children (class definitions)
    /// - Building cache keys for style resolution
    /// - Style resolution logic that shouldn't include inherited noise
    ///
    /// ## When NOT to use
    /// Do not use for rendering or layout - use `computed_style` instead (accessed
    /// via prop extractors in style_pass), which includes inherited properties and
    /// represents what the user will actually see.
    ///
    /// ## Warning
    /// The view styles do not store property transition states, only markers of which
    /// properties _should_ be transitioned over time on change.
    ///
    /// If you have a property that could be transitioned over time, make sure to use
    /// a [prop extractor](crate::prop_extractor) that is updated in a style method
    /// of the View to extract the property.
    pub fn get_combined_style(&self) -> Style {
        self.state().borrow().combined_style.clone()
    }

    /// Add a class to the list of style classes that are associated with this `ViewId`
    pub fn add_class(&self, class: StyleClassRef) {
        let state = self.state();
        state.borrow_mut().classes.push(class);
        self.request_style(StyleReason::class_cx(smallvec![class]));
    }

    /// Remove a class from the list of style classes that are associated with this `ViewId`
    pub fn remove_class(&self, class: StyleClassRef) {
        let state = self.state();
        state.borrow_mut().classes.retain_mut(|c| *c != class);
        self.request_style(StyleReason::class_cx(smallvec![class]));
    }

    pub(crate) fn update_style(&self, offset: StackOffset<Style>, style: Style) {
        let state = VIEW_STORAGE.with_borrow(|s| s.states.get(*self).cloned());
        if let Some(state) = state {
            state.borrow_mut().style.set(offset, style);
            self.request_style(StyleReason::full_recalc());
        }
    }

    /// Set the cursor.
    ///
    /// This will be overridden by any cursor set by view styles and will be overriden by cursors set on visual ids.
    pub fn set_cursor(&self, cursor: Option<crate::style::CursorStyle>) {
        self.state().borrow_mut().user_cursor = cursor;
    }

    /// Disables the default view behavior for the specified event.
    ///
    /// Children will still see the event, but the view event function will not be called nor the event listeners on the view
    pub fn disable_default_event(&self, event: EventListenerKey) {
        self.state()
            .borrow_mut()
            .disable_default_events
            .insert(event);
    }

    /// Re-enables the default view behavior for a previously disabled event.
    pub fn remove_disable_default_event(&self, event: EventListenerKey) {
        self.state()
            .borrow_mut()
            .disable_default_events
            .remove(&event);
    }

    /// Alter the visibility of the current window the view represented by this ID
    /// is in.
    pub fn window_visible(&self, visible: bool) {
        self.add_update_message(UpdateMessage::WindowVisible(visible));
    }

    /// Request removal of views during the update phase.
    ///
    /// This schedules the views to be removed with proper cleanup
    /// (cleanup listeners, taffy nodes, recursive children removal).
    /// Used by `keyed_children` for efficient keyed diffing.
    pub fn request_remove_views(&self, view_ids: Vec<ViewId>) {
        if !view_ids.is_empty() {
            self.add_update_message(UpdateMessage::RemoveViews(view_ids));
        }
    }

    /// Queue a child to be added during the next update cycle.
    ///
    /// The child will be constructed when the message is processed. The scope
    /// is resolved at build time by looking up the parent's context scope in
    /// the view hierarchy, enabling proper context propagation.
    pub fn add_child_deferred(&self, child_fn: impl FnOnce() -> AnyView + 'static) {
        self.add_update_message(UpdateMessage::AddChild {
            parent_id: *self,
            child: DeferredChild::new(child_fn),
        });
    }

    /// Queue multiple children to be added during the next update cycle.
    ///
    /// The children will be constructed when the message is processed. The scope
    /// is resolved at build time by looking up the parent's context scope in
    /// the view hierarchy, enabling proper context propagation.
    pub fn add_children_deferred(&self, children_fn: impl FnOnce() -> Vec<AnyView> + 'static) {
        self.add_update_message(UpdateMessage::AddChildren {
            parent_id: *self,
            children: DeferredChildren::new(children_fn),
        });
    }

    /// Queue a reactive children setup to run during the next update cycle.
    ///
    /// The setup function will be called inside the view's scope (resolved via `find_scope()`)
    /// when the message is processed. This enables lazy setup of reactive children
    /// (derived_children, derived_child, keyed_children) inside the correct scope for context access.
    pub fn setup_reactive_children_deferred(&self, setup: impl FnOnce() + 'static) {
        self.add_update_message(UpdateMessage::SetupReactiveChildren {
            setup: DeferredReactiveSetup::new(*self, setup),
        });
    }

    fn add_update_message(&self, msg: UpdateMessage) {
        let _ = CENTRAL_UPDATE_MESSAGES.try_with(|msgs| {
            let mut msgs = msgs.borrow_mut();
            msgs.push((*self, msg));
        });
    }

    /// Send a state update that will be placed in deferred messages
    // TODO: what is the difference?
    pub fn update_state_deferred(&self, state: impl Any) {
        CENTRAL_DEFERRED_UPDATE_MESSAGES.with_borrow_mut(|msgs| {
            msgs.push((*self, Box::new(state)));
        });
    }

    /// Get a layout in screen-coordinates for this view, if possible.
    pub fn screen_layout(&self) -> Option<ScreenLayout> {
        crate::layout::try_create_screen_layout(self)
    }

    /// Set the custom style parent to make it so that a view will pull it's style context from a different parent.
    /// This is useful for overlays that are children of the window root but should pull their style cx from the creating view
    pub fn set_style_parent(&self, parent_id: ViewId) {
        self.state().borrow_mut().style_cx_parent = Some(parent_id);
    }

    /// Clear the custom style parent
    pub fn clear_style_parent(&self) {
        self.state().borrow_mut().style_cx_parent = None;
    }

    /// Set the children scope for reactive children.
    ///
    /// This stores the scope used by `ParentView::derived_children` so that
    /// when children are updated, the old scope can be properly disposed.
    pub fn set_children_scope(&self, scope: Scope) {
        self.state().borrow_mut().children_scope = Some(scope);
    }

    /// Take and dispose the children scope, returning the old scope if it existed.
    ///
    /// This is called when reactive children are updated to clean up the old scope.
    pub fn take_children_scope(&self) -> Option<Scope> {
        self.state().borrow_mut().children_scope.take()
    }

    /// Set the keyed children state for reactive keyed children.
    ///
    /// This stores the children and their scopes used by `ParentView::keyed_children`.
    /// Each child has its own scope that gets disposed when the child is removed.
    pub fn set_keyed_children(&self, children: Vec<(ViewId, Scope)>) {
        self.state().borrow_mut().keyed_children = Some(children);
    }

    /// Take the keyed children state, returning it if it existed.
    ///
    /// This is called when keyed children are updated to apply diffs.
    pub fn take_keyed_children(&self) -> Option<Vec<(ViewId, Scope)>> {
        self.state().borrow_mut().keyed_children.take()
    }

    /// Set the scope for this view.
    ///
    /// Views that provide context to children (like Combobox, Dialog, etc.) should
    /// call this in their `into_view()` to store their scope. This scope is then
    /// used when processing deferred children so they have access to the context.
    ///
    /// The scope hierarchy is kept in sync with the view hierarchy, so when
    /// a parent scope is disposed, all child scopes are also disposed.
    pub fn set_scope(&self, scope: Scope) {
        self.state().borrow_mut().scope = Some(scope);
    }

    /// Get the scope for this view, if one was set.
    pub fn scope(&self) -> Option<Scope> {
        self.state().borrow().scope
    }

    /// Find the nearest ancestor (including self) that has a scope.
    ///
    /// This walks up the view tree to find the first view with a scope,
    /// which should be used when building deferred children.
    pub fn find_scope(&self) -> Option<Scope> {
        // Check self first
        if let Some(scope) = self.scope() {
            return Some(scope);
        }
        // Walk up ancestors
        let mut current = self.parent();
        while let Some(parent_id) = current {
            if let Some(scope) = parent_id.scope() {
                return Some(scope);
            }
            current = parent_id.parent();
        }
        None
    }

    /// get the local clip
    pub fn get_local_clip(&self) -> Option<RoundedRect> {
        let element_id = self.get_element_id();
        VIEW_STORAGE
            .with_borrow_mut(|s| {
                let box_tree = s.box_tree(*self);
                box_tree.borrow().local_clip(element_id.0)
            })
            .flatten()
    }

    /// Create a visual that is a child of the current view.
    ///
    /// This will make it so that the visual id can receive events through the `ViewID`
    pub fn create_child_element_id(&self, z_index: i32) -> ElementId {
        let parent_box_node = self.get_element_id();
        VIEW_STORAGE.with_borrow_mut(|s| {
            let box_tree = s.box_tree(*self);
            let child_element_id = box_tree.borrow_mut().push_child(
                Some(parent_box_node.0),
                understory_box_tree::LocalNode::default(),
            );
            let element_id = ElementId(child_element_id, *self, false);
            box_tree
                .borrow_mut()
                .set_meta(child_element_id, Some(crate::ElementMeta::new(element_id)));
            box_tree.borrow_mut().set_z_index(child_element_id, z_index);
            element_id
        })
    }

    /// Read focus navigation metadata for a specific element owned by this view.
    pub fn focus_nav_meta_for_element(&self, element_id: ElementId) -> Option<FocusNavMeta> {
        let box_tree = self.box_tree();
        box_tree
            .borrow()
            .meta(element_id.0)
            .flatten()
            .map(|m| m.focus)
    }

    /// Replace focus navigation metadata for a specific element.
    ///
    /// Returns `false` when the element is stale and no metadata was written.
    pub fn set_focus_nav_meta_for_element(
        &self,
        element_id: ElementId,
        focus: FocusNavMeta,
    ) -> bool {
        debug_assert_eq!(
            element_id.owning_id(),
            *self,
            "element must be owned by this view"
        );
        let box_tree = self.box_tree();
        let mut box_tree = box_tree.borrow_mut();
        let Some(mut meta) = box_tree.meta(element_id.0).flatten() else {
            return false;
        };
        meta.focus = focus;
        box_tree.set_meta(element_id.0, Some(meta));
        crate::bump_focus_nav_meta_revision();
        true
    }

    /// Set or clear group membership used by keyboard focus traversal policies.
    pub fn set_focus_group_for_element(
        &self,
        element_id: ElementId,
        group: Option<understory_focus::FocusSymbol>,
    ) -> bool {
        let Some(mut focus) = self.focus_nav_meta_for_element(element_id) else {
            return false;
        };
        focus.group = group;
        self.set_focus_nav_meta_for_element(element_id, focus)
    }

    /// Register this view to receive a specific event type.
    ///
    /// Views must register for events they want to receive through the broadcast
    /// dispatch system, such as [`LayoutChanged`](crate::context::LayoutChanged)
    /// or [`VisualChanged`](crate::context::VisualChanged).
    pub fn register_listener(&self, key: listener::EventListenerKey) {
        self.add_update_message(UpdateMessage::RegisterListener(key, *self));
    }

    /// Unregister this view from receiving a specific event type.
    pub fn remove_listener(&self, key: listener::EventListenerKey) {
        self.add_update_message(UpdateMessage::RemoveListener(key, *self));
    }

    pub(crate) fn get_layout_window_origin(&self) -> Point {
        self.state().borrow().layout_window_origin
    }

    /// Dispatch an event to this view using the specified routing strategy.
    ///
    /// This queues an event to be dispatched during the next event processing cycle.
    /// The event will be routed according to the `dispatch_kind` parameter.
    ///
    /// # Arguments
    ///
    /// * `event` - The event to dispatch
    /// * `dispatch_kind` - The routing strategy to use:
    ///   - `DispatchKind::Directed { target, phases }` - Routes to target with specified phases
    ///     - Use `Phases::all()` for full capture/bubble
    ///     - Use `Phases::TARGET` for direct dispatch only
    ///     - Use `Phases::BUBBLE` for bubble-only dispatch
    ///   - `DispatchKind::Spatial { point, phases }` - Routes based on hit testing at a point
    ///   - `DispatchKind::Subtree { target, respect_propagation }` - Routes to target and all descendants
    ///   - `DispatchKind::Focused { phases }` - Routes to currently focused view
    ///   - `DispatchKind::Global { respect_propagation }` - Broadcasts to all views
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use floem::context::Phases;
    /// # use floem::event::{Event, InteractionEvent, RouteKind};
    /// # use floem::ViewId;
    /// # let view_id = ViewId::new();
    /// # let focused_view = view_id.get_element_id();
    /// // Dispatch a click directly to a specific view (target only, no propagation)
    /// view_id.route_event(
    ///     Event::Interaction(InteractionEvent::Click),
    ///     RouteKind::Directed {
    ///         target: view_id.get_element_id(),
    ///         phases: Phases::TARGET
    ///     }
    /// );
    ///
    /// // Dispatch a key event with full capture/bubble phases
    /// # if false {
    /// # let key_event = unimplemented!();
    /// # view_id.route_event(
    /// #     Event::Key(key_event),
    /// #     RouteKind::Directed {
    /// #         target: focused_view,
    /// #         phases: Phases::all()
    /// #     }
    /// # );
    /// # }
    /// ```
    pub fn route_event(&self, event: crate::event::Event, route_kind: RouteKind) {
        self.route_event_with_caused_by(event, route_kind, None);
    }

    /// Dispatch an event with an optional causing event.
    ///
    /// This is similar to `dispatch_event`, but allows you to specify an event that caused
    /// this dispatch. The causing event will be available in the `EventCx::caused_by` field.
    ///
    /// # Arguments
    ///
    /// * `event` - The event to dispatch
    /// * `dispatch_kind` - The routing strategy to use
    /// * `caused_by` - An optional event that caused this dispatch (e.g., a PointerDown that caused a Click)
    pub fn route_event_with_caused_by(
        &self,
        event: crate::event::Event,
        route_kind: RouteKind,
        caused_by: Option<crate::event::Event>,
    ) {
        self.add_update_message(UpdateMessage::RouteEvent {
            id: self.get_element_id(),
            event: Box::new(event),
            route_kind,
            triggered_by: caused_by.map(Box::new),
        });
    }
}

impl From<ViewId> for ElementId {
    fn from(value: ViewId) -> Self {
        value.get_element_id()
    }
}

/// Re-parent a child view's scope under the nearest ancestor's scope.
///
/// This ensures that the Scope hierarchy matches the View hierarchy, which is
/// important for proper cleanup - when a parent scope is disposed, all child
/// scopes (and their signals/effects) are also disposed.
///
/// This handles the case where views are constructed eagerly (children created
/// before parents) - the scopes may have been created in the wrong order, so
/// we fix up the hierarchy when the view tree is assembled.
///
/// If the parent scope can't be found yet (because the view tree isn't fully
/// assembled), the child is added to a pending list and will be re-parented
/// later via `process_pending_scope_reparents`.
fn reparent_scope_if_needed(child_id: ViewId, parent_id: ViewId) {
    // Get child's scope (if it has one)
    let child_scope = child_id.scope();
    if let Some(child_scope) = child_scope {
        // Find the nearest ancestor with a scope
        if let Some(parent_scope) = parent_id.find_scope() {
            // Guard: Don't create a cycle if same scope is on both views
            if child_scope != parent_scope {
                // Re-parent child's scope under parent's scope
                child_scope.set_parent(parent_scope);
            }
        } else {
            // Parent scope not found yet - the view tree might not be fully assembled.
            // Add to pending list for later processing.
            PENDING_SCOPE_REPARENTS.with_borrow_mut(|pending| {
                pending.insert(child_id);
            });
        }
    }
}

/// Process any views that had scope re-parenting deferred.
///
/// This should be called after the view tree is fully assembled (e.g., after
/// processing all update messages). It attempts to re-parent scopes that
/// couldn't find a parent scope when they were first added.
pub fn process_pending_scope_reparents() {
    // Fast path: skip if nothing pending (common case)
    let has_pending = PENDING_SCOPE_REPARENTS.with_borrow(|pending| !pending.is_empty());
    if !has_pending {
        return;
    }

    PENDING_SCOPE_REPARENTS.with_borrow_mut(|pending| {
        pending.retain(|child_id| {
            // First check if this ViewId is still valid (not from a disposed view/window)
            // This is important for parallel test isolation
            if !child_id.is_valid() {
                return false; // Remove stale ViewId from pending
            }

            // Check if view still exists and has a scope
            let child_scope = child_id.scope();
            if let Some(child_scope) = child_scope {
                // Try to find a parent scope by walking up from the parent
                if let Some(parent_id) = child_id.parent()
                    && let Some(parent_scope) = parent_id.find_scope()
                {
                    // Guard: Don't create a cycle if same scope is on both views
                    if child_scope != parent_scope {
                        child_scope.set_parent(parent_scope);
                    }
                    return false; // Successfully handled, remove from pending
                }
                true // Still pending, keep in the set
            } else {
                false // No scope, remove from pending
            }
        });
    });
}

fn box_tree_parent_element_id_for_child(
    storage: &mut ViewStorage,
    logical_parent_id: ViewId,
    child_id: ViewId,
) -> ElementId {
    if storage.overlays.contains_key(child_id) {
        let root_id = *storage
            .root
            .get(child_id)
            .expect("all view ids are created with a root");
        storage.state(root_id).borrow().element_id
    } else {
        storage.state(logical_parent_id).borrow().element_id
    }
}

impl ViewId {
    /// Set the selected state for child views during styling.
    /// This should be used by parent views to propagate selected state to their children.
    /// Only requests a style update if the state actually changes.
    pub fn parent_set_selected(&self) {
        let changed = {
            let state = self.state();
            let mut state = state.borrow_mut();
            if !state.parent_set_style_interaction.selected {
                state.parent_set_style_interaction.selected = true;
                true
            } else {
                false
            }
        };
        if changed {
            self.request_style(StyleReason::with_selector(StyleSelector::Selected));
        }
    }

    /// Clear the selected state for child views during styling.
    /// This should be used by parent views to clear selected state propagation to their children.
    /// Only requests a style update if the state actually changes.
    pub fn parent_clear_selected(&self) {
        let changed = {
            let state = self.state();
            let mut state = state.borrow_mut();
            if state.parent_set_style_interaction.selected {
                state.parent_set_style_interaction.selected = false;
                true
            } else {
                false
            }
        };
        if changed {
            self.request_style(StyleReason::with_selector(StyleSelector::Selected));
        }
    }

    /// Set the disabled state for child views during styling.
    /// This should be used by parent views to propagate disabled state to their children.
    /// Only requests a style update if the state actually changes.
    pub fn parent_set_disabled(&self) {
        let changed = {
            let state = self.state();
            let mut state = state.borrow_mut();
            if !state.parent_set_style_interaction.disabled {
                state.parent_set_style_interaction.disabled = true;
                true
            } else {
                false
            }
        };
        if changed {
            self.request_style(StyleReason::with_selector(StyleSelector::Disabled));
        }
    }

    /// Clear the disabled state for child views during styling.
    /// This should be used by parent views to clear disabled state propagation to their children.
    /// Only requests a style update if the state actually changes.
    pub fn parent_clear_disabled(&self) {
        let changed = {
            let state = self.state();
            let mut state = state.borrow_mut();
            if state.parent_set_style_interaction.disabled {
                state.parent_set_style_interaction.disabled = false;
                true
            } else {
                false
            }
        };
        if changed {
            self.request_style(StyleReason::with_selector(StyleSelector::Disabled));
        }
    }

    /// Hide this view from layout. Sets the parent set visibility state directly.
    /// Skips the normal transition animation logic.
    /// This should be used by parent views to set hidden state propagation to their children.
    /// Only requests a style update if the state actually changes.
    pub fn set_hidden(&self) {
        use crate::view::state::VisibilityPhase;
        let changed = {
            let state = self.state();
            let mut state = state.borrow_mut();
            if !state.parent_set_style_interaction.hidden {
                state.parent_set_style_interaction.hidden = true;
                state.visibility.phase = VisibilityPhase::Hidden;
                true
            } else {
                false
            }
        };
        if changed {
            self.request_style(StyleReason::visibility());
        }
    }

    /// Show this view in layout. Clears the parent set hidden state.
    /// This should be used by parent views to clear hidden state propagation to their children.
    /// Only requests a style update if the state actually changes.
    pub fn set_visible(&self) {
        use crate::view::state::VisibilityPhase;
        let changed = {
            let state = self.state();
            let mut state = state.borrow_mut();
            if state.parent_set_style_interaction.hidden {
                state.parent_set_style_interaction.hidden = false;
                // Reset phase to Initial so the normal transition logic can run
                state.visibility.phase = VisibilityPhase::Initial;
                true
            } else {
                false
            }
        };
        if changed {
            self.request_style(StyleReason::visibility());
        }
    }
}