Struct Element 

pub struct Element {
    pub type_id: TypeId,
    pub widget: Box<dyn Widget>,
}

A container for any widget implementing the Widget trait. A container for any widget implementing the Widget trait.

This is the primary type used to store and manipulate widgets in layout trees. Element wraps a widget in a dynamic trait object.

Use Element::new to convert a widget into an Element.

Fields

type_id: TypeId

widget: Box<dyn Widget>

Implementations

impl Element

pub fn new<W>(widget: W) -> Self

where W: Widget + 'static,

Creates a new Element from a given widget.

This is commonly used to wrap widgets when composing layouts.

Example

let span = Span::new("Hello");
let element = Element::new(span);

pub fn map<W: Widget + 'static, F: FnOnce(W) -> W>(self, f: F) -> Self

pub fn downcast_ref<W: Widget>(&self) -> Option<&W>

Downcasts widget stored in the Element to given type, returns optional reference to the downcast widget on success.

pub fn downcast_mut<W: Widget>(&mut self) -> Option<&mut W>

Downcasts widget stored in the Element to given type, returns optional mutable reference to the downcast widget on success.

Trait Implementations

impl Debug for Element

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

Formats the value using the given formatter.

impl<W> From<BgGrad<W>> for Element

where W: Widget + 'static,

fn from(value: BgGrad<W>) -> Self

Converts to this type from the input type.

impl<W> From<Block<W>> for Element

where W: Widget + 'static,

fn from(value: Block<W>) -> Self

Converts to this type from the input type.

impl From<Grad> for Element

fn from(value: Grad) -> Self

Converts to this type from the input type.

impl From<Grid> for Element

fn from(value: Grid) -> Self

Converts to this type from the input type.

impl From<Layout> for Element

fn from(value: Layout) -> Self

Converts to this type from the input type.

impl From<List> for Element

fn from(value: List) -> Self

Converts to this type from the input type.

impl From<Overlay> for Element

fn from(value: Overlay) -> Self

Converts to this type from the input type.

impl From<Paragraph> for Element

fn from(value: Paragraph) -> Self

Converts to this type from the input type.

impl From<ProgressBar> for Element

fn from(value: ProgressBar) -> Self

Converts to this type from the input type.

impl<W> From<Scrollable<W>> for Element

where W: Widget + 'static,

fn from(value: Scrollable<W>) -> Self

Converts to this type from the input type.

impl From<Scrollbar> for Element

fn from(value: Scrollbar) -> Self

Converts to this type from the input type.

impl From<Spacer> for Element

fn from(value: Spacer) -> Self

Converts to this type from the input type.

impl From<Span> for Element

fn from(value: Span) -> Self

Converts to this type from the input type.

impl<T> From<T> for Element

where T: AsRef<str>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl From<Table> for Element

fn from(value: Table) -> Self

Converts to this type from the input type.

impl Widget for Element

fn render(&self, buffer: &mut Buffer, rect: Rect, cache: &mut Cache)

Renders the widget into the given Buffer within the provided Rect bounds.

fn height(&self, size: &Vec2) -> usize

Returns the height of the Widget based on the width of the given size.

fn width(&self, size: &Vec2) -> usize

Returns the width of the Widget based on the height of the given size.

fn children(&self) -> Vec<&Element>

Gets widget’s children