Struct UseClickOutside 

pub struct UseClickOutside {
    pub target: NodeRef<Element>,
    pub triggered: Signal<bool>,
    /* private fields */
}

Reactive state for a click-outside watcher.

The handle carries the element the hook watches — a NodeRef the caller attaches to its own markup — and the signal that is raised when a pointer press lands outside that element.

The watcher listens on the document rather than on the element itself. That is deliberate: the element does not exist while the first render is being built, so a listener attached to it would have nothing to attach to, and a document listener sees the press either way and can then ask whether the pressed node sits inside the watched element.

Fields

target: NodeRef<Element>

The element the hook watches.

Attach it to the caller’s markup with the ref: attribute.

triggered: Signal<bool>

Raised when a press landed outside the watched element.

Implementations

impl UseClickOutside

Inherent implementation of UseClickOutside.

pub fn is_triggered(&self) -> bool

Returns the current trigger state as a snapshot.

Returns

• bool - true when the last press landed outside.

pub fn reset(&self)

Clears the trigger, so the next outside press is a new event.

impl UseClickOutside

pub fn get_target(&self) -> &NodeRef<Element>

pub fn get_mut_target(&mut self) -> &mut NodeRef<Element>

pub fn set_target(&mut self, val: NodeRef<Element>) -> &mut Self

pub fn get_triggered(&self) -> Signal<bool>

pub fn get_mut_triggered(&mut self) -> &mut Signal<bool>

pub fn set_triggered(&mut self, val: Signal<bool>) -> &mut Self

pub fn get_mut_teardown(&mut self) -> &mut Rc<RefCell<Option<Box<dyn Fn()>>>>

pub fn set_teardown( &mut self, val: Rc<RefCell<Option<Box<dyn Fn()>>>>, ) -> &mut Self

Trait Implementations

impl Clone for UseClickOutside

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UseClickOutside

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the struct fields as a debug struct, skipping excluded fields.

Arguments

• &mut std::fmt::Formatter<'_> - The formatter to write the representation into.

Returns

• std::fmt::Result - Success or failure of the formatting operation.