Struct patternfly_yew::GlobalClose

source ·

pub struct GlobalClose { /* private fields */ }

Expand description

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§

source §

impl GlobalClose

source

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

Examples found in repository ?

src/dropdown.rs (line 50)

    fn create(ctx: &Context<Self>) -> Self {
        Self {
            expanded: false,
            global_close: GlobalClose::new(NodeRef::default(), ctx.link().callback(|_| Msg::Close)),
        }
    }

More examples

Hide additional examples

src/select.rs (line 96)

    fn create(ctx: &Context<Self>) -> Self {
        Self {
            expanded: false,
            global_close: GlobalClose::new(NodeRef::default(), ctx.link().callback(|_| Msg::Close)),
            selection: Vec::new(),
        }
    }

src/app_launcher.rs (line 37)

    fn create(ctx: &Context<Self>) -> Self {
        let global_close =
            GlobalClose::new(NodeRef::default(), ctx.link().callback(|_| Msg::Close));
        Self {
            expanded: false,
            global_close,
        }
    }

src/context_selector.rs (line 33)

    fn create(ctx: &Context<Self>) -> Self {
        let global_close =
            GlobalClose::new(NodeRef::default(), ctx.link().callback(|_| Msg::Close));
        Self {
            expanded: false,
            global_close,
        }
    }

src/pagination.rs (lines 58-61)

    fn create(ctx: &Context<Self>) -> Self {
        Self {
            expanded: false,
            global_close: GlobalClose::new(
                NodeRef::default(),
                ctx.link().callback(|_| Msg::CloseMenu),
            ),
        }
    }

src/popper.rs (line 68)

    fn create(ctx: &Context<Self>) -> Self {
        Self {
            target: NodeRef::default(),
            popper: None,
            _callback: None,
            active: false,
            state: None,
            _marker: Default::default(),
            global_close: GlobalClose::new(NodeRef::default(), ctx.link().callback(|_| Msg::Close)),
        }
    }