Struct tuirealm::view::View

pub struct View { /* fields omitted */ }

View

View is the wrapper and manager for all the components. A View is a container for all the components in a certain layout. Each View can have only one focused component.

Implementations

impl View

pub fn init() -> Self

init

Initialize a new View

pub fn mount(&mut self, id: &str, component: Box<dyn Component>)

mount

Mount a new component in the view

pub fn umount(&mut self, id: &str)

umount

Umount a component from the view. If component has focus, blur component and remove it from the stack

pub fn render(&self, id: &str, frame: &mut Canvas<'_>, area: Rect)

render

RenderData component with the provided id

pub fn get_props(&self, id: &str) -> Option<Props>

get_props

Get component properties

pub fn update(&mut self, id: &str, props: Props) -> Option<(String, Msg)>

update

Update component properties Returns None if component doesn’t exist

pub fn get_state(&self, id: &str) -> Option<Payload>

get_state

Get component state

pub fn on(&mut self, ev: Event) -> Option<(String, Msg)>

on

Handle event for the focused component (if any) Returns None if no component is focused

pub fn blur(&mut self)

blur

Blur selected element AND DON’T PUSH CURRENT ACTIVE ELEMENT INTO THE STACK Last element in stack becomes active and is removed from the stack

pub fn active(&mut self, component: &str)

active

Active provided element Current active component, if any, GETS PUSHED to the STACK