Struct leptos::PortalProps

pub struct PortalProps {
    pub mount: Option<Element>,
    pub use_shadow: bool,
    pub is_svg: bool,
    pub children: ChildrenFn,
}

Props for the Portal component.

Renders components somewhere else in the DOM.

Useful for inserting modals and tooltips outside of a cropping layout. If no mount point is given, the portal is inserted in document.body; it is wrapped in a <div> unless is_svg is true in which case it’s wrappend in a <g>. Setting use_shadow to true places the element in a shadow root to isolate styles.

Required Props

• children: ChildrenFn
  • The children to teleport into the mount element

Optional Props

• mount: impl Into<web_sys::Element>
  • Target element where the children will be appended
• use_shadow: bool
  • Whether to use a shadow DOM inside mount. Defaults to false.
• is_svg: bool
  • When using SVG this has to be set to true. Defaults to false.

Fields

mount: Option<Element>

Target element where the children will be appended

use_shadow: bool

Whether to use a shadow DOM inside mount. Defaults to false.

is_svg: bool

When using SVG this has to be set to true. Defaults to false.

children: ChildrenFn

The children to teleport into the mount element

Implementations

impl PortalProps

pub fn builder() -> PortalPropsBuilder<((), (), (), ())>

Create a builder for building PortalProps. On the builder, call .mount(...)(optional), .use_shadow(...)(optional), .is_svg(...)(optional), .children(...) to set the values of the fields. Finally, call .build() to create the instance of PortalProps.

Trait Implementations

impl IntoView for PortalProps

fn into_view(self) -> View

Converts the value into View.