Struct Overlay 

pub struct Overlay<M = ()>(/* private fields */);

overlay: a floating panel or sheet in layer.

Implementations

impl<M> Overlay<M>

pub fn key(self, key: impl Into<NodeKey>) -> Self

Identity among siblings: keeps the node’s id (and Tern’s view state) across reorders. A string, or an integer.

pub fn role(self, role: impl Into<String>) -> Self

A name of yours, exposed to CSS as data-role.

pub fn tone(self, tone: impl Into<Tone>) -> Self

The semantic color of the node’s chrome.

pub fn hidden(self, hidden: bool) -> Self

Keeps the node mounted but not laid out.

pub fn mark(self, mark: impl Into<Mark>) -> Self

A transient selection mark drawn over the node.

pub fn aria(self, aria: impl Into<String>) -> Self

The accessible name of a node that shows no text.

pub fn hovercard<N>(self, card: impl Into<Node<N>>) -> Self

A floating card of card’s tree shown while the pointer rests on the node, in place of title. Sent id-less (ids, keys and handlers inside are ignored); an older Tern ignores it.

pub fn href(self, href: impl Into<String>) -> Self

A link: ⌘-click opens it; copy and open use it.

pub fn grow(self, grow: f64) -> Self

Flex grow inside a row or col.

pub fn shrink(self, shrink: f64) -> Self

Flex shrink inside a row or col.

pub fn basis(self, basis: impl Into<Basis>) -> Self

Flex basis: a fraction of the parent, or the content’s size.

pub fn prop(self, name: &str, value: impl Serialize) -> Self

Sets any prop untyped; null removes it.

pub fn min(self, min: Bound) -> Self

Lower size bounds.

pub fn title(self, title: impl Into<String>) -> Self

A tooltip.

pub fn max(self, max: Bound) -> Self

Upper size bounds (a max.h also clips the node).

pub fn actions(self, actions: Actions) -> Self

What a pointer does, by action name.

pub fn on_click(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on a click (sets actions.click to "click" unless the node names its click action itself).

pub fn on_dblclick(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on a double click (sets actions.dblclick to "dblclick" unless the node names it).

pub fn on_menu(self, act: impl Into<String>, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Adds act to the context menu and sends msg when it is picked.

pub fn on_action(self, act: impl Into<String>, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on action events whose action is act (name or name=value).

pub fn on_action_with( self, act: impl Into<String>, f: impl Fn(&Action) -> M + Send + Sync + 'static, ) -> Self

Maps action events whose action is act to a message.

pub fn on_toggle(self, f: impl Fn(bool) -> M + Send + Sync + 'static) -> Self

Maps toggle events (the new collapsed; a menu, select or trace line that opened is not collapsed) to a message.

pub fn on_select(self, f: impl Fn(&str) -> M + Send + Sync + 'static) -> Self

Maps select events (the item) to a message. On a list’s item the item’s own handler runs first.

pub fn on_activate(self, f: impl Fn(&str) -> M + Send + Sync + 'static) -> Self

Maps activate events (the item) to a message.

pub fn on_change(self, f: impl Fn(&Change) -> M + Send + Sync + 'static) -> Self

Maps change events to a message.

pub fn on_focus(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on focus events (a click asked for the keys).

pub fn on_edit(self, f: impl Fn(&Edit) -> M + Send + Sync + 'static) -> Self

Maps edit events (native editing) to a message.

pub fn on_undo(self, msg: M) -> Self

where M: Clone + Send + Sync + 'static,

Sends msg on undo events.

pub fn on_send(self, f: impl Fn(&str) -> M + Send + Sync + 'static) -> Self

Maps send events (the text to submit) to a message.

impl<M> Overlay<M>

pub fn child(self, child: impl Into<Node<M>>) -> Self

Adds a child.

pub fn children<C: Into<Node<M>>>( self, children: impl IntoIterator<Item = C>, ) -> Self

Adds children.

impl<M> Overlay<M>

pub fn anchor(self, value: impl Into<Anchor>) -> Self

Placement.

pub fn size(self, value: impl Into<OverlaySize>) -> Self

Card width or full sheet; with side, the sheet’s width or the drawer’s height.

pub fn modal(self, value: impl Into<bool>) -> Self

A dim backdrop taking the pointer.

pub fn head(self, value: impl Into<Text>) -> Self

The title row.

pub fn side(self, value: impl Into<OverlaySide>) -> Self

Docks it to an edge: a full-height sheet or a bottom drawer (wins over anchor).

pub fn variant(self, value: impl Into<OverlayVariant>) -> Self

With side: flush with the edge or inset from it.

pub fn icon(self, icon: impl Into<Icon>) -> Self

The head icon (wins over the role’s).

pub fn meta(self, meta: impl Into<Text>) -> Self

Muted facts after the head text.

pub fn end(self, end: impl Into<Slot<M>>) -> Self

A node drawn at the head’s end (buttons, segmented tabs, badges); clicks on it never fold the panel.

pub fn size_fraction(self, fraction: f64) -> Self

With side: the sheet’s width or the drawer’s height as a fraction of the layer, in (0, 1].

pub fn foot(self, foot: impl Into<Slot<M>>) -> Self

A node drawn in a sticky footer bar under the body (the sheet’s actions).

Trait Implementations

impl<M> Clone for Overlay<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Overlay<M>

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

Formats the value using the given formatter.

impl<M> From<Node<M>> for Overlay<M>

fn from(node: Node<M>) -> Self

Converts to this type from the input type.

impl<M> From<Overlay<M>> for Slot<M>

fn from(n: Overlay<M>) -> Self

Converts to this type from the input type.

impl<M> From<Overlay<M>> for Node<M>

fn from(n: Overlay<M>) -> Self

Converts to this type from the input type.

impl<M> From<Overlay<M>> for View<M>

A bare node is main’s one child.

fn from(n: Overlay<M>) -> Self

Converts to this type from the input type.