Struct patternfly_yew::GlobalClose

pub struct GlobalClose { /* fields omitted */ }

Helper to trigger a close operation, when the user clicks on the global space.

This can be e.g. used for a drop down menu, where the component should be closed when the user clicks outside of the dropped down content.

In order to use this, you need to define and assign the NodeRef to an element which is considered the “inside”. When the user clicks “outside” of the referenced element, it will execute the callback.

When the instance is dropped, the callback will no longer be fired.

When creating the structure, you can pass in a new NodeRef, and you can deref and clone later using the function GlobalClose::node_ref.

Implementations

impl GlobalClose

pub fn new(node_ref: NodeRef, callback: Callback<()>) -> Self

pub fn node_ref(&self) -> NodeRef

Methods from Deref<Target = NodeRef>

pub fn get(&self) -> Option<Node>

Get the wrapped Node reference if it exists

pub fn cast<INTO>(&self) -> Option<INTO> where
    INTO: AsRef<Node> + From<JsValue>, 

Try converting the node reference into another form

Trait Implementations

impl Deref for GlobalClose

type Target = NodeRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for GlobalClose

fn drop(&mut self)

Executes the destructor for this type.