Struct Query

pub struct Query { /* private fields */ }

Allows querying the layout of nodes after rendering. It will only provide a correct value after a node is rendered. Provided as a root context for all tui applictions.

Example

use dioxus::prelude::*;
use dioxus_tui::query::Query;
use dioxus_tui::Size;

fn main() {
    dioxus_tui::launch(app);
}

fn app(cx: Scope) -> Element {
    let hue = use_state(cx, || 0.0);
    let brightness = use_state(cx, || 0.0);
    let tui_query: Query = cx.consume_context().unwrap();
    cx.render(rsx! {
        div{
            width: "100%",
            background_color: "hsl({hue}, 70%, {brightness}%)",
            onmousemove: move |evt| {
                let node = tui_query.get(cx.root_node().mounted_id());
                let Size{width, height} = node.size().unwrap();
                hue.set((evt.data.offset_x as f32/width as f32)*255.0);
                brightness.set((evt.data.offset_y as f32/height as f32)*100.0);
            },
            "hsl({hue}, 70%, {brightness}%)",
        }
    })
}

Implementations

impl Query

pub fn new(rdom: Arc<RwLock<RealDom>>, stretch: Arc<Mutex<Taffy>>) -> Query

pub fn get(&self, id: EntityId) -> ElementRef<'_>

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Unique for Query

type Tracking = Untracked

Specify what this storage should track. Can be one of: track::Untracked, track::Insertion, track::Modification, track::Removal, track::All.