dioxus_document/elements/
meta.rs

1use super::*;
2use crate::document;
3use dioxus_html as dioxus_elements;
4
5#[non_exhaustive]
6/// Props for the [`Meta`] component
7#[derive(Clone, Props, PartialEq)]
8pub struct MetaProps {
9    pub property: Option<String>,
10    pub name: Option<String>,
11    pub charset: Option<String>,
12    pub http_equiv: Option<String>,
13    pub content: Option<String>,
14    #[props(extends = meta, extends = GlobalAttributes)]
15    pub additional_attributes: Vec<Attribute>,
16}
17
18impl MetaProps {
19    /// Get all the attributes for the meta tag
20    pub fn attributes(&self) -> Vec<(&'static str, String)> {
21        let mut attributes = Vec::new();
22        extend_attributes(&mut attributes, &self.additional_attributes);
23        if let Some(property) = &self.property {
24            attributes.push(("property", property.clone()));
25        }
26        if let Some(name) = &self.name {
27            attributes.push(("name", name.clone()));
28        }
29        if let Some(charset) = &self.charset {
30            attributes.push(("charset", charset.clone()));
31        }
32        if let Some(http_equiv) = &self.http_equiv {
33            attributes.push(("http-equiv", http_equiv.clone()));
34        }
35        if let Some(content) = &self.content {
36            attributes.push(("content", content.clone()));
37        }
38        attributes
39    }
40}
41
42/// Render a [`meta`](crate::elements::meta) tag into the head of the page.
43///
44/// # Example
45///
46/// ```rust, no_run
47/// # use dioxus::prelude::*;
48/// fn RedirectToDioxusHomepageWithoutJS() -> Element {
49///     rsx! {
50///         // You can use the meta component to render a meta tag into the head of the page
51///         // This meta tag will redirect the user to the dioxuslabs homepage in 10 seconds
52///         document::Meta {
53///             http_equiv: "refresh",
54///             content: "10;url=https://dioxuslabs.com",
55///         }
56///     }
57/// }
58/// ```
59///
60/// <div class="warning">
61///
62/// Any updates to the props after the first render will not be reflected in the head.
63///
64/// </div>
65#[component]
66#[doc(alias = "<meta>")]
67pub fn Meta(props: MetaProps) -> Element {
68    use_update_warning(&props, "Meta {}");
69
70    use_hook(|| {
71        let document = document();
72        document.create_meta(props);
73    });
74
75    VNode::empty()
76}
dioxus_document/elements/meta.rs

dioxus_document/elements/
meta.rs
