Skip to main content

NodeOverlayProps

Struct NodeOverlayProps 

Source
pub struct NodeOverlayProps {
    pub anchor: OverlayAnchor,
    pub side: OverlaySide,
    pub align: OverlayAlign,
    pub offset: f64,
    pub keep_in_view: bool,
    pub track_anchor: bool,
    pub backdrop: bool,
    pub on_dismiss: Option<Callback<()>>,
    pub style: Option<String>,
    pub children: ChildrenFn,
}
Expand description

Props for the NodeOverlay component.

A panel anchored to a node (or to an element inside one), rendered at the graph-pane level so it escapes the node’s clipping and the canvas transform.

Mount it to open and unmount it to close — there is no open prop, so the caller keeps full control (and the children’s reactive owner is only alive while the panel is). on_dismiss fires on a pointerdown outside the panel and on Escape; acting on it is the caller’s choice.

See the module docs for why this exists.

§Required Props

§Optional Props

  • anchor: OverlayAnchor
    • What to position against. Defaults to the enclosing node.
  • side: OverlaySide
  • align: OverlayAlign
  • offset: f64
    • Gap between anchor and panel, in unscaled pixels.
  • keep_in_view: bool
    • Flip to the opposite side when the panel doesn’t fit, then shift it to stay inside the pane.
  • track_anchor: bool
    • Re-place every frame, so the panel follows its anchor through node drags and content reflow. Pan and zoom are tracked either way.
  • backdrop: bool
    • Render a transparent click-catching backdrop over the pane, which fires on_dismiss when clicked.
  • on_dismiss: impl Into<Callback<()>>
    • Fired on a pointerdown outside the panel, and on Escape.
  • style: impl Into<String>
    • Extra style on the panel wrapper (e.g. "width: 320px;").

Fields§

§anchor: OverlayAnchor

What to position against. Defaults to the enclosing node.

§side: OverlaySide§align: OverlayAlign§offset: f64

Gap between anchor and panel, in unscaled pixels.

§keep_in_view: bool

Flip to the opposite side when the panel doesn’t fit, then shift it to stay inside the pane.

§track_anchor: bool

Re-place every frame, so the panel follows its anchor through node drags and content reflow. Pan and zoom are tracked either way.

§backdrop: bool

Render a transparent click-catching backdrop over the pane, which fires on_dismiss when clicked.

§on_dismiss: Option<Callback<()>>

Fired on a pointerdown outside the panel, and on Escape.

§style: Option<String>

Extra style on the panel wrapper (e.g. "width: 320px;").

§children: ChildrenFn

Implementations§

Source§

impl NodeOverlayProps

Source

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

Create a builder for building NodeOverlayProps. On the builder, call .anchor(...)(optional), .side(...)(optional), .align(...)(optional), .offset(...)(optional), .keep_in_view(...)(optional), .track_anchor(...)(optional), .backdrop(...)(optional), .on_dismiss(...)(optional), .style(...)(optional), .children(...) to set the values of the fields. Finally, call .build() to create the instance of NodeOverlayProps.

Trait Implementations§

Source§

impl Props for NodeOverlayProps

Source§

type Builder = NodeOverlayPropsBuilder

Source§

fn builder() -> Self::Builder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<El, T, Marker> IntoElementMaybeSignal<T, Marker> for El
where El: IntoElementMaybeSignalType<T, Marker>,

Source§

impl<T, Js> IntoElementMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

impl<El, T, Marker> IntoElementsMaybeSignal<T, Marker> for El
where El: IntoElementsMaybeSignalType<T, Marker>,

Source§

impl<T, Js> IntoElementsMaybeSignalType<T, Element> for Js
where T: From<Js> + Clone,

Source§

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more