Struct sycamore::view::View

pub struct View<G>
where
    G: GenericNode,
{ /* private fields */ }

Represents an UI view. Usually constructed using the view! macro or using the builder API.

Example

let my_view: View<G> = view! {
    div {
        p { "A view." }
    }
};

Implementations

impl<G> View<G>

where G: GenericNode,

pub fn new_node(node: G) -> View<G>

Create a new View from a raw node.

pub fn new_dyn(f: impl FnMut() -> View<G> + 'static) -> View<G>

Create a new dynamic View from a FnMut.

pub fn new_fragment(fragment: Vec<View<G>>) -> View<G>

Create a new View fragment from a Vec of Views.

pub fn empty() -> View<G>

Create a new View with a blank marker node

Note that this is different from an empty view fragment. Instead, this is a single marker (dummy) node.

pub fn as_node(&self) -> Option<&G>

Try to cast to a GenericNode, or None if wrong type.

pub fn as_fragment(&self) -> Option<&[View<G>]>

Try to cast to a slice representing the view fragment, or None if wrong type.

pub fn as_dyn(&self) -> Option<ReadSignal<View<G>>>

Try to cast to the underlying [RcSignal] for a dynamic view, or None if wrong type.

pub fn is_node(&self) -> bool

Returns true if the view is a single node. Note that if the view is a fragment containing only a single child node, this will still return false.

To check whether the View only contains a single node, use .flatten().len() == 1 instead.

pub fn is_fragment(&self) -> bool

Returns true if the view is a view fragment.

pub fn is_dyn(&self) -> bool

Returns true if the view is a dynamic view.

pub fn flatten(self) -> Vec<G>

Returns a recursively flattened Vec of raw nodes.

If the current view is dynamic or is a fragment containing dynamic views, the dynamic views will be accessed reactively.

Trait Implementations

impl<G> Clone for View<G>

where G: Clone + GenericNode,

fn clone(&self) -> View<G>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G> Debug for View<G>

where G: GenericNode,

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

Formats the value using the given formatter.

impl<G> Default for View<G>

where G: GenericNode,

fn default() -> View<G>

Returns the “default value” for a type.

impl<G: GenericNode> ElementBuilderOrView<G> for View<G>

fn into_view(self) -> View<G>

Convert into a View.

impl<G> From<View<G>> for Children<G>

where G: GenericNode,

fn from(view: View<G>) -> Children<G>

Converts to this type from the input type.

impl<G> ToView<G> for View<G>

where G: GenericNode,

fn to_view(&self) -> View<G>

Tautology of converting a View into a View. This allows us to interpolate views into other views.