1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
//! The main html module which defines components, listeners, and class helpers.
mod classes;
mod component;
mod conversion;
mod error;
mod listener;
use std::cell::RefCell;
use std::rc::Rc;
pub use classes::*;
pub use component::*;
pub use conversion::*;
pub use error::*;
pub use listener::*;
use wasm_bindgen::JsValue;
use web_sys::{Element, Node};
use crate::sealed::Sealed;
use crate::virtual_dom::{VNode, VPortal};
/// A type which expected as a result of `view` function implementation.
pub type Html = VNode;
/// An enhanced type of `Html` returned in suspendible function components.
pub type HtmlResult = RenderResult<Html>;
impl Sealed for HtmlResult {}
impl Sealed for Html {}
/// A trait to translate into a [`HtmlResult`].
pub trait IntoHtmlResult: Sealed {
/// Performs the conversion.
fn into_html_result(self) -> HtmlResult;
}
impl IntoHtmlResult for HtmlResult {
#[inline(always)]
fn into_html_result(self) -> HtmlResult {
self
}
}
impl IntoHtmlResult for Html {
#[inline(always)]
fn into_html_result(self) -> HtmlResult {
Ok(self)
}
}
/// Wrapped Node reference for later use in Component lifecycle methods.
///
/// # Example
/// Focus an `<input>` element on mount.
/// ```
/// use web_sys::HtmlInputElement;
/// # use yew::prelude::*;
///
/// pub struct Input {
/// node_ref: NodeRef,
/// }
///
/// impl Component for Input {
/// type Message = ();
/// type Properties = ();
///
/// fn create(_ctx: &Context<Self>) -> Self {
/// Input {
/// node_ref: NodeRef::default(),
/// }
/// }
///
/// fn rendered(&mut self, _ctx: &Context<Self>, first_render: bool) {
/// if first_render {
/// if let Some(input) = self.node_ref.cast::<HtmlInputElement>() {
/// input.focus();
/// }
/// }
/// }
///
/// fn view(&self, _ctx: &Context<Self>) -> Html {
/// html! {
/// <input ref={self.node_ref.clone()} type="text" />
/// }
/// }
/// }
/// ```
/// ## Relevant examples
/// - [Node Refs](https://github.com/yewstack/yew/tree/master/examples/node_refs)
#[derive(Default, Clone)]
pub struct NodeRef(Rc<RefCell<NodeRefInner>>);
impl PartialEq for NodeRef {
fn eq(&self, other: &Self) -> bool {
self.0.as_ptr() == other.0.as_ptr()
}
}
impl std::fmt::Debug for NodeRef {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"NodeRef {{ references: {:?} }}",
self.get().map(|n| crate::utils::print_node(&n))
)
}
}
#[derive(PartialEq, Debug, Default, Clone)]
struct NodeRefInner {
node: Option<Node>,
}
impl NodeRef {
/// Get the wrapped Node reference if it exists
pub fn get(&self) -> Option<Node> {
let inner = self.0.borrow();
inner.node.clone()
}
/// Try converting the node reference into another form
pub fn cast<INTO: AsRef<Node> + From<JsValue>>(&self) -> Option<INTO> {
let node = self.get();
node.map(Into::into).map(INTO::from)
}
}
#[cfg(feature = "csr")]
mod feat_csr {
use super::*;
impl NodeRef {
pub(crate) fn set(&self, new_ref: Option<Node>) {
let mut inner = self.0.borrow_mut();
inner.node = new_ref;
}
}
}
/// Render children into a DOM node that exists outside the hierarchy of the parent
/// component.
/// ## Relevant examples
/// - [Portals](https://github.com/yewstack/yew/tree/master/examples/portals)
pub fn create_portal(child: Html, host: Element) -> Html {
VNode::VPortal(Rc::new(VPortal::new(child, host)))
}