Struct silkenweb::node::Component

pub struct Component<D: InstantiableDom = DefaultDom> { /* private fields */ }

A lightweight type to encapsulate HTML and CSS using shadow DOM.

See Using Shadow DOM for some background on shadow DOM.

The slot and multi_slot methods generate a slot name and assign it to their arguments. They return a slot, which should be added to the shadow DOM with the child or children methods.

Example

This creates a <div> with an open shadow root attached. The light DOM will contain the name and description spans, assigned to a slot each. The shadow DOM will contain the <dl>, <dt>, and <dd> elements and slots for the light DOM elements. HTML id attributes and CSS are encapsulated by the shadow DOM.

let name = span().text("HTML");
let description = span().text("HyperText Markup Language");

css!(content = "span {border: 3px solid red}");

let mut term = Component::<Dry>::styled(stylesheet::text());
let name_slot = term.slot(name);
let description_slot = term.slot(description);

term.child(
    div().child(span().text("Term Definition")).child(
        dl().child(dt().child(name_slot))
            .child(dd().child(description_slot)),
    ),
);

Implementations

impl<D: InstantiableDom> Component<D>

pub fn new() -> Self

Constructor

pub fn styled(css: &str) -> Self

Constuct a Component with a <style> element in the shadow DOM.

pub fn slot(&mut self, child: impl HtmlElement + ChildNode<D>) -> Slot<D>

Add child to the light DOM.

See Component documentation for more details.

pub fn multi_slot<E>( &mut self, children: impl IntoIterator<Item = E> ) -> Slot<D>

where E: HtmlElement + ChildNode<D>,

Add children to the light DOM.

See Component documentation for more details.

pub fn child(self, child: impl ChildNode<D>) -> Self

Add child to the shadow DOM.

pub fn children<N>( self, children: impl IntoIterator<Item = N> + 'static ) -> Self

where N: ChildNode<D>,

Add children to the shadow DOM.

Trait Implementations

impl<D: InstantiableDom> Default for Component<D>

fn default() -> Self

Returns the “default value” for a type.

impl<D: InstantiableDom> From<Component<D>> for GenericElement<D>

fn from(value: Component<D>) -> Self

Converts to this type from the input type.

impl<D: InstantiableDom> From<Component<D>> for GenericElement<D, Const>

fn from(value: Component<D>) -> Self

Converts to this type from the input type.

impl<D: InstantiableDom> From<Component<D>> for Node<D>

fn from(value: Component<D>) -> Self

Converts to this type from the input type.

impl<D: InstantiableDom> InDom for Component<D>

type Dom = D

impl<D: InstantiableDom> Value for Component<D>