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 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504
//! Exports types for working with HTML elements.
use cfg_if::cfg_if;
cfg_if! {
if #[cfg(all(target_arch = "wasm32", feature = "web"))] {
use crate::events::*;
use crate::macro_helpers::*;
use crate::{mount_child, MountKind};
use once_cell::unsync::Lazy as LazyCell;
use std::cell::Cell;
use wasm_bindgen::JsCast;
/// Trait alias for the trait bounts on [`ElementDescriptor`].
pub trait ElementDescriptorBounds:
fmt::Debug + AsRef<web_sys::HtmlElement> + Clone
{
}
impl<El> ElementDescriptorBounds for El where
El: fmt::Debug + AsRef<web_sys::HtmlElement> + Clone
{
}
thread_local! {
static IS_META: Cell<bool> = Cell::new(false);
}
#[doc(hidden)]
pub fn as_meta_tag<T>(f: impl FnOnce() -> T) -> T {
IS_META.with(|m| m.set(true));
let v = f();
IS_META.with(|m| m.set(false));
v
}
fn is_meta_tag() -> bool {
IS_META.with(|m| m.get())
}
} else {
use crate::hydration::HydrationKey;
use smallvec::{smallvec, SmallVec};
pub(crate) const HTML_ELEMENT_DEREF_UNIMPLEMENTED_MSG: &str =
"`Deref<Target = web_sys::HtmlElement>` and `AsRef<web_sys::HtmlElement>` \
can only be used on web targets. \
This is for the same reason that normal `wasm_bindgen` methods can be used \
only in the browser. Please use `leptos::is_server()` or \
`leptos::is_browser()` to check where you're running.";
/// Trait alias for the trait bounts on [`ElementDescriptor`].
pub trait ElementDescriptorBounds: fmt::Debug {}
impl<El> ElementDescriptorBounds for El where El: fmt::Debug {}
#[doc(hidden)]
pub fn as_meta_tag<T>(f: impl FnOnce() -> T) -> T {
f()
}
}
}
use crate::{
ev::EventDescriptor,
hydration::HydrationCtx,
macro_helpers::{IntoAttribute, IntoClass, IntoProperty},
Element, Fragment, IntoView, NodeRef, Text, View,
};
use leptos_reactive::Scope;
use std::{borrow::Cow, fmt};
/// Trait which allows creating an element tag.
pub trait ElementDescriptor: ElementDescriptorBounds {
/// The name of the element, i.e., `div`, `p`, `custom-element`.
fn name(&self) -> Cow<'static, str>;
/// Determines if the tag is void, i.e., `<input>` and `<br>`.
fn is_void(&self) -> bool {
false
}
/// A unique `id` that should be generated for each new instance of
/// this element, and be consistent for both SSR and CSR.
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
fn hydration_id(&self) -> &HydrationKey;
}
/// Trait for converting any type which impl [`AsRef<web_sys::Element>`]
/// to [`HtmlElement`].
pub trait ToHtmlElement {
/// Converts the type to [`HtmlElement`].
fn to_leptos_element(self, cx: Scope) -> HtmlElement<AnyElement>;
}
impl<T> ToHtmlElement for T
where
T: AsRef<web_sys::Element>,
{
fn to_leptos_element(self, cx: Scope) -> HtmlElement<AnyElement> {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
let el = self.as_ref().clone().unchecked_into();
let element = AnyElement {
name: "".into(),
is_void: false,
element: el,
};
HtmlElement {
cx,
element,
#[cfg(debug_assertions)]
span: ::tracing::Span::current(),
#[cfg(debug_assertions)]
view_marker: None,
}
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
let _ = cx;
unreachable!();
}
}
}
/// Represents potentially any element.
#[derive(Clone, Debug)]
pub struct AnyElement {
pub(crate) name: Cow<'static, str>,
#[cfg(all(target_arch = "wasm32", feature = "web"))]
pub(crate) element: web_sys::HtmlElement,
pub(crate) is_void: bool,
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
pub(crate) id: HydrationKey,
}
impl std::ops::Deref for AnyElement {
type Target = web_sys::HtmlElement;
fn deref(&self) -> &Self::Target {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
return &self.element;
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
unimplemented!("{HTML_ELEMENT_DEREF_UNIMPLEMENTED_MSG}");
}
}
impl std::convert::AsRef<web_sys::HtmlElement> for AnyElement {
fn as_ref(&self) -> &web_sys::HtmlElement {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
return &self.element;
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
unimplemented!("{HTML_ELEMENT_DEREF_UNIMPLEMENTED_MSG}");
}
}
impl ElementDescriptor for AnyElement {
fn name(&self) -> Cow<'static, str> {
self.name.clone()
}
fn is_void(&self) -> bool {
self.is_void
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
fn hydration_id(&self) -> &HydrationKey {
&self.id
}
}
/// Represents a custom HTML element, such as `<my-element>`.
#[derive(Clone, Debug)]
pub struct Custom {
name: Cow<'static, str>,
#[cfg(all(target_arch = "wasm32", feature = "web"))]
element: web_sys::HtmlElement,
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
id: HydrationKey,
}
impl Custom {
/// Creates a new custom element with the given tag name.
pub fn new(name: impl Into<Cow<'static, str>>) -> Self {
let name = name.into();
let id = HydrationCtx::id();
#[cfg(all(target_arch = "wasm32", feature = "web"))]
let element = if HydrationCtx::is_hydrating() {
if let Some(el) =
crate::document().get_element_by_id(&format!("_{id}"))
{
#[cfg(debug_assertions)]
assert_eq!(
el.node_name().to_ascii_uppercase(),
name.to_ascii_uppercase(),
"SSR and CSR elements have the same `TopoId` but \
different node kinds. This is either a discrepancy \
between SSR and CSR rendering
logic, which is considered a bug, or it can also be a \
leptos hydration issue."
);
el.remove_attribute("id").unwrap();
el.unchecked_into()
} else if let Ok(Some(el)) =
crate::document().query_selector(&format!("[leptos-hk=_{id}]"))
{
#[cfg(debug_assertions)]
assert_eq!(
el.node_name().to_ascii_uppercase(),
name.to_ascii_uppercase(),
"SSR and CSR elements have the same `TopoId` but \
different node kinds. This is either a discrepancy \
between SSR and CSR rendering
logic, which is considered a bug, or it can also be a \
leptos hydration issue."
);
el.remove_attribute("leptos-hk").unwrap();
el.unchecked_into()
} else {
if !is_meta_tag() {
crate::warn!(
"element with id {id} not found, ignoring it for \
hydration"
);
}
crate::document().create_element(&name).unwrap()
}
} else {
crate::document().create_element(&name).unwrap()
};
Self {
name,
#[cfg(all(target_arch = "wasm32", feature = "web"))]
element: element.unchecked_into(),
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
id,
}
}
}
#[cfg(all(target_arch = "wasm32", feature = "web"))]
impl std::ops::Deref for Custom {
type Target = web_sys::HtmlElement;
fn deref(&self) -> &Self::Target {
&self.element
}
}
#[cfg(all(target_arch = "wasm32", feature = "web"))]
impl std::convert::AsRef<web_sys::HtmlElement> for Custom {
fn as_ref(&self) -> &web_sys::HtmlElement {
&self.element
}
}
impl ElementDescriptor for Custom {
fn name(&self) -> Cow<'static, str> {
self.name.clone()
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
fn hydration_id(&self) -> &HydrationKey {
&self.id
}
}
cfg_if! {
if #[cfg(all(target_arch = "wasm32", feature = "web"))] {
/// Represents an HTML element.
#[derive(Clone)]
pub struct HtmlElement<El: ElementDescriptor> {
#[cfg(debug_assertions)]
pub(crate) span: ::tracing::Span,
pub(crate) cx: Scope,
pub(crate) element: El,
#[cfg(debug_assertions)]
pub(crate) view_marker: Option<String>
}
// Server needs to build a virtualized DOM tree
} else {
/// Represents an HTML element.
#[derive(educe::Educe, Clone)]
#[educe(Debug)]
pub struct HtmlElement<El: ElementDescriptor> {
pub(crate) cx: Scope,
pub(crate) element: El,
pub(crate) attrs: SmallVec<[(Cow<'static, str>, Cow<'static, str>); 4]>,
#[educe(Debug(ignore))]
pub(crate) children: ElementChildren,
#[cfg(debug_assertions)]
pub(crate) view_marker: Option<String>
}
#[derive(Clone, educe::Educe, PartialEq, Eq)]
#[educe(Default)]
pub(crate) enum ElementChildren {
#[educe(Default)]
Empty,
Children(Vec<View>),
InnerHtml(Cow<'static, str>),
Chunks(Vec<StringOrView>)
}
#[doc(hidden)]
#[derive(Clone)]
pub enum StringOrView {
String(Cow<'static, str>),
View(std::rc::Rc<dyn Fn() -> View>)
}
impl PartialEq for StringOrView {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(StringOrView::String(a), StringOrView::String(b)) => a == b,
_ => false
}
}
}
impl Eq for StringOrView {}
}
}
impl<El> std::ops::Deref for HtmlElement<El>
where
El: ElementDescriptor + std::ops::Deref,
{
type Target = <El as std::ops::Deref>::Target;
fn deref(&self) -> &Self::Target {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
return self.element.deref();
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
unimplemented!("{HTML_ELEMENT_DEREF_UNIMPLEMENTED_MSG}");
}
}
impl<El: ElementDescriptor + 'static> HtmlElement<El> {
pub(crate) fn new(cx: Scope, element: El) -> Self {
cfg_if! {
if #[cfg(all(target_arch = "wasm32", feature = "web"))] {
Self {
cx,
element,
#[cfg(debug_assertions)]
span: ::tracing::Span::current(),
#[cfg(debug_assertions)]
view_marker: None
}
} else {
Self {
cx,
attrs: smallvec![],
children: Default::default(),
element,
#[cfg(debug_assertions)]
view_marker: None
}
}
}
}
#[doc(hidden)]
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
#[deprecated = "Use HtmlElement::from_chunks() instead."]
pub fn from_html(
cx: Scope,
element: El,
html: impl Into<Cow<'static, str>>,
) -> Self {
Self {
cx,
attrs: smallvec![],
children: ElementChildren::Chunks(vec![StringOrView::String(
html.into(),
)]),
element,
#[cfg(debug_assertions)]
view_marker: None,
}
}
#[doc(hidden)]
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
pub fn from_chunks(
cx: Scope,
element: El,
chunks: impl IntoIterator<Item = StringOrView>,
) -> Self {
Self {
cx,
attrs: smallvec![],
children: ElementChildren::Chunks(chunks.into_iter().collect()),
element,
#[cfg(debug_assertions)]
view_marker: None,
}
}
#[cfg(debug_assertions)]
/// Adds an optional marker indicating the view macro source.
pub fn with_view_marker(mut self, marker: impl Into<String>) -> Self {
self.view_marker = Some(marker.into());
self
}
/// Converts this element into [`HtmlElement<AnyElement>`].
pub fn into_any(self) -> HtmlElement<AnyElement> {
cfg_if! {
if #[cfg(all(target_arch = "wasm32", feature = "web"))] {
let Self {
cx,
element,
#[cfg(debug_assertions)]
span,
#[cfg(debug_assertions)]
view_marker
} = self;
HtmlElement {
cx,
element: AnyElement {
name: element.name(),
element: element.as_ref().clone(),
is_void: element.is_void(),
},
#[cfg(debug_assertions)]
span,
#[cfg(debug_assertions)]
view_marker
}
} else {
let Self {
cx,
attrs,
children,
element,
#[cfg(debug_assertions)]
view_marker
} = self;
HtmlElement {
cx,
attrs,
children,
element: AnyElement {
name: element.name(),
is_void: element.is_void(),
id: element.hydration_id().clone()
},
#[cfg(debug_assertions)]
view_marker
}
}
}
}
/// Adds an `id` to the element.
#[track_caller]
pub fn id(self, id: impl Into<Cow<'static, str>>) -> Self {
let id = id.into();
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
self.element
.as_ref()
.set_attribute(wasm_bindgen::intern("id"), &id)
.unwrap();
self
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
let mut this = self;
this.attrs.push(("id".into(), id));
this
}
}
/// Binds the element reference to [`NodeRef`].
pub fn node_ref(self, node_ref: NodeRef<El>) -> Self
where
Self: Clone,
{
#[cfg(all(target_arch = "wasm32", feature = "web"))]
node_ref.load(&self);
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
let _ = node_ref;
self
}
/// Runs the callback when this element has been mounted to the DOM.
///
/// ### Important Note
/// This method will only ever run at most once. If this element
/// is unmounted and remounted, or moved somewhere else, it will not
/// re-run unless you call this method again.
pub fn on_mount(self, f: impl FnOnce(Self) + 'static) -> Self {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
use futures::future::poll_fn;
use once_cell::unsync::OnceCell;
use std::{
cell::RefCell,
rc::Rc,
task::{Poll, Waker},
};
let this = self.clone();
let el = self.element.as_ref().clone();
wasm_bindgen_futures::spawn_local(async move {
while !crate::document().body().unwrap().contains(Some(&el)) {
// We need to cook ourselves a small future that resolves
// when the next animation frame is available
let waker = Rc::new(RefCell::new(None::<Waker>));
let ready = Rc::new(OnceCell::new());
crate::helpers::request_animation_frame({
let waker = waker.clone();
let ready = ready.clone();
move || {
let _ = ready.set(());
if let Some(waker) = &*waker.borrow() {
waker.wake_by_ref();
}
}
});
// Wait for the animation frame to become available
poll_fn(move |cx| {
let mut waker_borrow = waker.borrow_mut();
*waker_borrow = Some(cx.waker().clone());
if ready.get().is_some() {
Poll::Ready(())
} else {
Poll::<()>::Pending
}
})
.await;
}
f(this);
});
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
let _ = f;
}
self
}
/// Checks to see if this element is mounted to the DOM as a child
/// of `body`.
///
/// This method will always return [`None`] on non-wasm CSR targets.
pub fn is_mounted(&self) -> bool {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
crate::document()
.body()
.unwrap()
.contains(Some(self.element.as_ref()))
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
false
}
/// Adds an attribute to this element.
#[track_caller]
pub fn attr(
self,
name: impl Into<Cow<'static, str>>,
attr: impl IntoAttribute,
) -> Self {
let name = name.into();
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
attribute_helper(
self.element.as_ref(),
name,
attr.into_attribute(self.cx),
);
self
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
use crate::macro_helpers::Attribute;
let mut this = self;
let mut attr = attr.into_attribute(this.cx);
while let Attribute::Fn(_, f) = attr {
attr = f();
}
match attr {
Attribute::String(value) => {
this.attrs.push((name, value.into()));
}
Attribute::Bool(include) => {
if include {
this.attrs.push((name, "".into()));
}
}
Attribute::Option(_, maybe) => {
if let Some(value) = maybe {
this.attrs.push((name, value.into()));
}
}
_ => unreachable!(),
}
this
}
}
/// Adds a class to an element.
#[track_caller]
pub fn class(
self,
name: impl Into<Cow<'static, str>>,
class: impl IntoClass,
) -> Self {
let name = name.into();
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
let el = self.element.as_ref();
let value = class.into_class(self.cx);
class_helper(el, name, value);
self
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
use crate::macro_helpers::Class;
let mut this = self;
let class = class.into_class(this.cx);
let include = match class {
Class::Value(include) => include,
Class::Fn(_, f) => f(),
};
if include {
if let Some((_, ref mut value)) =
this.attrs.iter_mut().find(|(name, _)| name == "class")
{
*value = format!("{value} {name}").into();
} else {
this.attrs.push(("class".into(), name));
}
}
this
}
}
/// Adds a list of classes separated by ASCII whitespace to an element.
#[track_caller]
pub fn classes(self, classes: impl Into<Cow<'static, str>>) -> Self {
let classes = classes.into();
let mut this = self;
for class in classes.split_ascii_whitespace() {
this = this.class(class.to_string(), true);
}
this
}
/// Sets the class on the element as the class signal changes.
#[track_caller]
pub fn dyn_classes<I, C>(
self,
classes_signal: impl Fn() -> I + 'static,
) -> Self
where
I: IntoIterator<Item = C>,
C: Into<Cow<'static, str>>,
{
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
use smallvec::SmallVec;
let class_list = self.element.as_ref().class_list();
leptos_reactive::create_effect(
self.cx,
move |prev_classes: Option<
SmallVec<[Cow<'static, str>; 4]>,
>| {
let classes = classes_signal()
.into_iter()
.map(Into::into)
.collect::<SmallVec<[Cow<'static, str>; 4]>>(
);
let mut new_classes = classes
.iter()
.flat_map(|classes| classes.split_whitespace());
if let Some(prev_classes) = prev_classes {
let mut old_classes = prev_classes
.iter()
.flat_map(|classes| classes.split_whitespace());
// Remove old classes
for prev_class in old_classes.clone() {
if !new_classes.any(|c| c == prev_class) {
class_list.remove_1(prev_class).unwrap_or_else(
|err| {
panic!(
"failed to add class \
`{prev_class}`, error: {err:#?}"
)
},
);
}
}
// Add new classes
for class in new_classes {
if !old_classes.any(|c| c == class) {
class_list.add_1(class).unwrap_or_else(|err| {
panic!(
"failed to remove class `{class}`, \
error: {err:#?}"
)
});
}
}
} else {
let new_classes = new_classes
.map(ToOwned::to_owned)
.collect::<SmallVec<[_; 4]>>();
for class in &new_classes {
class_list.add_1(class).unwrap_or_else(|err| {
panic!(
"failed to add class `{class}`, error: \
{err:#?}"
)
});
}
}
classes
},
);
self
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
classes_signal()
.into_iter()
.map(Into::into)
.flat_map(|classes| {
classes
.split_whitespace()
.map(ToString::to_string)
.collect::<SmallVec<[_; 4]>>()
})
.fold(self, |this, class| this.class(class, true))
}
}
/// Sets a property on an element.
#[track_caller]
pub fn prop(
self,
name: impl Into<Cow<'static, str>>,
value: impl IntoProperty,
) -> Self {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
let name = name.into();
let value = value.into_property(self.cx);
let el = self.element.as_ref();
property_helper(el, name, value);
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
let _ = name;
let _ = value;
}
self
}
/// Adds an event listener to this element.
#[track_caller]
pub fn on<E: EventDescriptor + 'static>(
self,
event: E,
#[allow(unused_mut)] // used for tracing in debug
mut event_handler: impl FnMut(E::EventType) + 'static,
) -> Self {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
cfg_if! {
if #[cfg(debug_assertions)] {
let onspan = ::tracing::span!(
parent: &self.span,
::tracing::Level::TRACE,
"on",
event = %event.name()
);
let _onguard = onspan.enter();
}
}
let event_name = event.name();
let key = event.event_delegation_key();
if event.bubbles() {
add_event_listener(
self.element.as_ref(),
key,
event_name,
event_handler,
);
} else {
add_event_listener_undelegated(
self.element.as_ref(),
&event_name,
event_handler,
);
}
self
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
_ = event;
_ = event_handler;
self
}
}
/// Adds a child to this element.
#[track_caller]
pub fn child(self, child: impl IntoView) -> Self {
let child = child.into_view(self.cx);
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
if !HydrationCtx::is_hydrating() {
// add a debug-only, run-time warning for the SVG <a> element
#[cfg(debug_assertions)]
warn_on_ambiguous_a(self.element.as_ref(), &child);
mount_child(MountKind::Append(self.element.as_ref()), &child);
}
self
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
let mut this = self;
let children = &mut this.children;
match children {
ElementChildren::Empty => {
*children = ElementChildren::Children(vec![child]);
}
ElementChildren::Children(ref mut children) => {
children.push(child);
}
_ => {
crate::debug_warn!(
"Don’t call .child() on an HtmlElement if you’ve \
already called .inner_html() or \
HtmlElement::from_chunks()."
);
}
}
this
}
}
/// Sets the inner HTML of this element from the provided
/// string slice.
///
/// # Security
/// Be very careful when using this method. Always remember to
/// sanitize the input to avoid a cross-site scripting (XSS)
/// vulnerability.
pub fn inner_html(self, html: impl Into<Cow<'static, str>>) -> Self {
let html = html.into();
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
self.element.as_ref().set_inner_html(&html);
self
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
let mut this = self;
this.children = ElementChildren::InnerHtml(html);
this
}
}
}
impl<El: ElementDescriptor> IntoView for HtmlElement<El> {
#[cfg_attr(debug_assertions, instrument(level = "trace", name = "<HtmlElement />", skip_all, fields(tag = %self.element.name())))]
fn into_view(self, _: Scope) -> View {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
View::Element(Element::new(self.element))
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
{
let Self {
element,
mut attrs,
children,
#[cfg(debug_assertions)]
view_marker,
..
} = self;
let id = element.hydration_id().clone();
let mut element = Element::new(element);
let children = children;
if attrs.iter_mut().any(|(name, _)| name == "id") {
attrs.push(("leptos-hk".into(), format!("_{id}").into()));
} else {
attrs.push(("id".into(), format!("_{id}").into()));
}
element.attrs = attrs;
element.children = children;
#[cfg(debug_assertions)]
{
element.view_marker = view_marker;
}
View::Element(element)
}
}
}
impl<El: ElementDescriptor, const N: usize> IntoView for [HtmlElement<El>; N] {
#[cfg_attr(
debug_assertions,
instrument(level = "trace", name = "[HtmlElement; N]", skip_all)
)]
fn into_view(self, cx: Scope) -> View {
Fragment::new(self.into_iter().map(|el| el.into_view(cx)).collect())
.into_view(cx)
}
}
/// Creates any custom element, such as `<my-element>`.
pub fn custom<El: ElementDescriptor>(cx: Scope, el: El) -> HtmlElement<Custom> {
HtmlElement::new(
cx,
Custom {
name: el.name(),
#[cfg(all(target_arch = "wasm32", feature = "web"))]
element: el.as_ref().clone(),
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
id: el.hydration_id().clone(),
},
)
}
/// Creates a text node.
pub fn text(text: impl Into<Cow<'static, str>>) -> Text {
Text::new(text.into())
}
macro_rules! generate_html_tags {
($(
#[$meta:meta]
$(#[$void:ident])?
$tag:ident $([$trailing_:pat])? $el_type:ident
),* $(,)?) => {
paste::paste! {
$(
#[cfg(all(target_arch = "wasm32", feature = "web"))]
thread_local! {
static [<$tag:upper>]: LazyCell<web_sys::HtmlElement> = LazyCell::new(|| {
crate::document()
.create_element(stringify!($tag))
.unwrap()
.unchecked_into()
});
}
#[derive(Clone, Debug)]
#[$meta]
pub struct [<$tag:camel $($trailing_)?>] {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
element: web_sys::HtmlElement,
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
id: HydrationKey,
}
impl Default for [<$tag:camel $($trailing_)?>] {
fn default() -> Self {
let id = HydrationCtx::id();
#[cfg(all(target_arch = "wasm32", feature = "web"))]
let element = create_leptos_element(
&stringify!([<$tag:upper>]),
id,
|| {
[<$tag:upper>]
.with(|el|
el.clone_node()
.unwrap()
.unchecked_into()
)
}
);
Self {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
element,
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
id
}
}
}
impl std::ops::Deref for [<$tag:camel $($trailing_)?>] {
type Target = web_sys::$el_type;
fn deref(&self) -> &Self::Target {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
{
use wasm_bindgen::JsCast;
return &self.element.unchecked_ref();
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
unimplemented!("{HTML_ELEMENT_DEREF_UNIMPLEMENTED_MSG}");
}
}
impl std::convert::AsRef<web_sys::HtmlElement> for [<$tag:camel $($trailing_)?>] {
fn as_ref(&self) -> &web_sys::HtmlElement {
#[cfg(all(target_arch = "wasm32", feature = "web"))]
return &self.element;
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
unimplemented!("{HTML_ELEMENT_DEREF_UNIMPLEMENTED_MSG}");
}
}
impl ElementDescriptor for [<$tag:camel $($trailing_)?>] {
fn name(&self) -> Cow<'static, str> {
stringify!($tag).into()
}
#[cfg(not(all(target_arch = "wasm32", feature = "web")))]
fn hydration_id(&self) -> &HydrationKey {
&self.id
}
generate_html_tags! { @void $($void)? }
}
#[$meta]
#[cfg_attr(
debug_assertions,
instrument(
level = "trace",
name = "HtmlElement",
skip_all,
fields(
tag = %format!("<{}/>", stringify!($tag))
)
)
)]
pub fn $tag(cx: Scope) -> HtmlElement<[<$tag:camel $($trailing_)?>]> {
HtmlElement::new(cx, [<$tag:camel $($trailing_)?>]::default())
}
)*
}
};
(@void) => {};
(@void void) => {
fn is_void(&self) -> bool {
true
}
}
}
#[cfg(all(target_arch = "wasm32", feature = "web"))]
fn create_leptos_element(
tag: &str,
id: crate::HydrationKey,
clone_element: fn() -> web_sys::HtmlElement,
) -> web_sys::HtmlElement {
#[cfg(not(debug_assertions))]
{
_ = tag;
}
if HydrationCtx::is_hydrating() {
if let Some(el) = crate::document().get_element_by_id(&format!("_{id}"))
{
#[cfg(debug_assertions)]
assert_eq!(
&el.node_name().to_ascii_uppercase(),
tag,
"SSR and CSR elements have the same `TopoId` but different \
node kinds. This is either a discrepancy between SSR and CSR \
rendering
logic, which is considered a bug, or it can also be a leptos \
hydration issue."
);
el.remove_attribute("id").unwrap();
el.unchecked_into()
} else if let Ok(Some(el)) =
crate::document().query_selector(&format!("[leptos-hk=_{id}]"))
{
#[cfg(debug_assertions)]
assert_eq!(
el.node_name().to_ascii_uppercase(),
tag,
"SSR and CSR elements have the same `TopoId` but different \
node kinds. This is either a discrepancy between SSR and CSR \
rendering
logic, which is considered a bug, or it can also be a leptos \
hydration issue."
);
el.remove_attribute("leptos-hk").unwrap();
el.unchecked_into()
} else {
if !is_meta_tag() {
crate::warn!(
"element with id {id} not found, ignoring it for hydration"
);
}
clone_element()
}
} else {
clone_element()
}
}
#[cfg(all(debug_assertions, target_arch = "wasm32", feature = "web"))]
fn warn_on_ambiguous_a(parent: &web_sys::Element, child: &View) {
if let View::Element(el) = &child {
if (el.name == "a"
|| el.name == "script"
|| el.name == "style"
|| el.name == "title")
&& parent.namespace_uri() != el.element.namespace_uri()
{
crate::warn!(
"Warning: you are appending an SVG element to an HTML \
element, or an HTML element to an SVG. Typically, this \
occurs when you create an <a/> or <script/> with the `view` \
macro and append it to an SVG, but the framework assumed it \
was HTML when you created it. To specify that it is an SVG \
element, use <svg::{{tag name}}/> in the view macro."
)
}
}
}
generate_html_tags![
// ==========================
// Main root
// ==========================
/// The `<html>` HTML element represents the root (top-level element) of an HTML document, so it is also referred to as the root element. All other elements must be descendants of this element.
html HtmlHtmlElement,
// ==========================
// Document Metadata
// ==========================
/// The `<base>` HTML element specifies the base URL to use for all relative URLs in a document. There can be only one `<base>` element in a document.
#[void]
base HtmlBaseElement,
/// The `<head>` HTML element contains machine-readable information (metadata) about the document, like its title, scripts, and style sheets.
head HtmlHeadElement,
/// The `<link>` HTML element specifies relationships between the current document and an external resource. This element is most commonly used to link to CSS, but is also used to establish site icons (both "favicon" style icons and icons for the home screen and apps on mobile devices) among other things.
#[void]
link HtmlLinkElement,
/// The `<meta>` HTML element represents Metadata that cannot be represented by other HTML meta-related elements, like base, link, script, style or title.
#[void]
meta HtmlMetaElement,
/// The `<style>` HTML element contains style information for a document, or part of a document. It contains CSS, which is applied to the contents of the document containing the `<style>` element.
style HtmlStyleElement,
/// The `<title>` HTML element defines the document's title that is shown in a Browser's title bar or a page's tab. It only contains text; tags within the element are ignored.
title HtmlTitleElement,
// ==========================
// Sectioning Root
// ==========================
/// The `<body>` HTML element represents the content of an HTML document. There can be only one `<body>` element in a document.
body HtmlBodyElement,
// ==========================
// Content Sectioning
// ==========================
/// The `<address>` HTML element indicates that the enclosed HTML provides contact information for a person or people, or for an organization.
address HtmlElement,
/// The `<article>` HTML element represents a self-contained composition in a document, page, application, or site, which is intended to be independently distributable or reusable (e.g., in syndication). Examples include: a forum post, a magazine or newspaper article, or a blog entry, a product card, a user-submitted comment, an interactive widget or gadget, or any other independent item of content.
article HtmlElement,
/// The `<aside>` HTML element represents a portion of a document whose content is only indirectly related to the document's main content. Asides are frequently presented as sidebars or call-out boxes.
aside HtmlElement,
/// The `<footer>` HTML element represents a footer for its nearest sectioning content or sectioning root element. A `<footer>` typically contains information about the author of the section, copyright data or links to related documents.
footer HtmlElement,
/// The `<header>` HTML element represents introductory content, typically a group of introductory or navigational aids. It may contain some heading elements but also a logo, a search form, an author name, and other elements.
header HtmlElement,
/// The `<hgroup>` HTML element represents a heading and related content. It groups a single `<h1>–<h6>` element with one or more `<p>`.
hgroup HtmlElement,
/// The `<h1>` to `<h6>` HTML elements represent six levels of section headings. `<h1>` is the highest section level and `<h6>` is the lowest.
h1 HtmlHeadingElement,
/// The `<h1>` to `<h6>` HTML elements represent six levels of section headings. `<h1>` is the highest section level and `<h6>` is the lowest.
h2 HtmlHeadingElement,
/// The `<h1>` to `<h6>` HTML elements represent six levels of section headings. `<h1>` is the highest section level and `<h6>` is the lowest.
h3 HtmlHeadingElement,
/// The `<h1>` to `<h6>` HTML elements represent six levels of section headings. `<h1>` is the highest section level and `<h6>` is the lowest.
h4 HtmlHeadingElement,
/// The `<h1>` to `<h6>` HTML elements represent six levels of section headings. `<h1>` is the highest section level and `<h6>` is the lowest.
h5 HtmlHeadingElement,
/// The `<h1>` to `<h6>` HTML elements represent six levels of section headings. `<h1>` is the highest section level and `<h6>` is the lowest.
h6 HtmlHeadingElement,
/// The `<main>` HTML element represents the dominant content of the body of a document. The main content area consists of content that is directly related to or expands upon the central topic of a document, or the central functionality of an application.
main HtmlElement,
/// The `<nav>` HTML element represents a section of a page whose purpose is to provide navigation links, either within the current document or to other documents. Common examples of navigation sections are menus, tables of contents, and indexes.
nav HtmlElement,
/// The `<section>` HTML element represents a generic standalone section of a document, which doesn't have a more specific semantic element to represent it. Sections should always have a heading, with very few exceptions.
section HtmlElement,
// ==========================
// Text Content
// ==========================
/// The `<blockquote>` HTML element indicates that the enclosed text is an extended quotation. Usually, this is rendered visually by indentation (see Notes for how to change it). A URL for the source of the quotation may be given using the cite attribute, while a text representation of the source can be given using the cite element.
blockquote HtmlQuoteElement,
/// The `<dd>` HTML element provides the description, definition, or value for the preceding term (dt) in a description list (dl).
dd HtmlElement,
/// The `<div>` HTML element is the generic container for flow content. It has no effect on the content or layout until styled in some way using CSS (e.g. styling is directly applied to it, or some kind of layout model like Flexbox is applied to its parent element).
div HtmlDivElement,
/// The `<dl>` HTML element represents a description list. The element encloses a list of groups of terms (specified using the dt element) and descriptions (provided by dd elements). Common uses for this element are to implement a glossary or to display metadata (a list of key-value pairs).
dl HtmlDListElement,
/// The `<dt>` HTML element specifies a term in a description or definition list, and as such must be used inside a dl element. It is usually followed by a dd element; however, multiple `<dt>` elements in a row indicate several terms that are all defined by the immediate next dd element.
dt HtmlElement,
/// The `<figcaption>` HTML element represents a caption or legend describing the rest of the contents of its parent figure element.
figcaption HtmlElement,
/// The `<figure>` HTML element represents self-contained content, potentially with an optional caption, which is specified using the figcaption element. The figure, its caption, and its contents are referenced as a single unit.
figure HtmlElement,
/// The `<hr>` HTML element represents a thematic break between paragraph-level elements: for example, a change of scene in a story, or a shift of topic within a section.
#[void]
hr HtmlHrElement,
/// The `<li>` HTML element is used to represent an item in a list. It must be contained in a parent element: an ordered list (ol), an unordered list (ul), or a menu (menu). In menus and unordered lists, list items are usually displayed using bullet points. In ordered lists, they are usually displayed with an ascending counter on the left, such as a number or letter.
li HtmlLiElement,
/// The `<ol>` HTML element represents an ordered list of items — typically rendered as a numbered list.
ol HtmlOListElement,
/// The `<p>` HTML element represents a paragraph. Paragraphs are usually represented in visual media as blocks of text separated from adjacent blocks by blank lines and/or first-line indentation, but HTML paragraphs can be any structural grouping of related content, such as images or form fields.
p HtmlParagraphElement,
/// The `<pre>` HTML element represents preformatted text which is to be presented exactly as written in the HTML file. The text is typically rendered using a non-proportional, or "monospaced, font. Whitespace inside this element is displayed as written.
pre HtmlPreElement,
/// The `<ul>` HTML element represents an unordered list of items, typically rendered as a bulleted list.
ul HtmlUListElement,
// ==========================
// Inline Text Semantics
// ==========================
/// The `<a>` HTML element (or anchor element), with its href attribute, creates a hyperlink to web pages, files, email addresses, locations in the same page, or anything else a URL can address.
a HtmlAnchorElement,
/// The `<abbr>` HTML element represents an abbreviation or acronym; the optional title attribute can provide an expansion or description for the abbreviation. If present, title must contain this full description and nothing else.
abbr HtmlElement,
/// The `<b>` HTML element is used to draw the reader's attention to the element's contents, which are not otherwise granted special importance. This was formerly known as the Boldface element, and most browsers still draw the text in boldface. However, you should not use `<b>` for styling text; instead, you should use the CSS font-weight property to create boldface text, or the strong element to indicate that text is of special importance.
b HtmlElement,
/// The `<bdi>` HTML element tells the browser's bidirectional algorithm to treat the text it contains in isolation from its surrounding text. It's particularly useful when a website dynamically inserts some text and doesn't know the directionality of the text being inserted.
bdi HtmlElement,
/// The `<bdo>` HTML element overrides the current directionality of text, so that the text within is rendered in a different direction.
bdo HtmlElement,
/// The `<br>` HTML element produces a line break in text (carriage-return). It is useful for writing a poem or an address, where the division of lines is significant.
#[void]
br HtmlBrElement,
/// The `<cite>` HTML element is used to describe a reference to a cited creative work, and must include the title of that work. The reference may be in an abbreviated form according to context-appropriate conventions related to citation metadata.
cite HtmlElement,
/// The `<code>` HTML element displays its contents styled in a fashion intended to indicate that the text is a short fragment of computer code. By default, the content text is displayed using the user agent default monospace font.
code HtmlElement,
/// The `<data>` HTML element links a given piece of content with a machine-readable translation. If the content is time- or date-related, the time element must be used.
data HtmlDataElement,
/// The `<dfn>` HTML element is used to indicate the term being defined within the context of a definition phrase or sentence. The p element, the dt/dd pairing, or the section element which is the nearest ancestor of the `<dfn>` is considered to be the definition of the term.
dfn HtmlElement,
/// The `<em>` HTML element marks text that has stress emphasis. The `<em>` element can be nested, with each level of nesting indicating a greater degree of emphasis.
em HtmlElement,
/// The `<i>` HTML element represents a range of text that is set off from the normal text for some reason, such as idiomatic text, technical terms, taxonomical designations, among others. Historically, these have been presented using italicized type, which is the original source of the `<i>` naming of this element.
i HtmlElement,
/// The `<kbd>` HTML element represents a span of inline text denoting textual user input from a keyboard, voice input, or any other text entry device. By convention, the user agent defaults to rendering the contents of a `<kbd>` element using its default monospace font, although this is not mandated by the HTML standard.
kbd HtmlElement,
/// The `<mark>` HTML element represents text which is marked or highlighted for reference or notation purposes, due to the marked passage's relevance or importance in the enclosing context.
mark HtmlElement,
/// The `<q>` HTML element indicates that the enclosed text is a short inline quotation. Most modern browsers implement this by surrounding the text in quotation marks. This element is intended for short quotations that don't require paragraph breaks; for long quotations use the blockquote element.
q HtmlQuoteElement,
/// The `<rp>` HTML element is used to provide fall-back parentheses for browsers that do not support display of ruby annotations using the ruby element. One `<rp>` element should enclose each of the opening and closing parentheses that wrap the rt element that contains the annotation's text.
rp HtmlElement,
/// The `<rt>` HTML element specifies the ruby text component of a ruby annotation, which is used to provide pronunciation, translation, or transliteration information for East Asian typography. The `<rt>` element must always be contained within a ruby element.
rt HtmlElement,
/// The `<ruby>` HTML element represents small annotations that are rendered above, below, or next to base text, usually used for showing the pronunciation of East Asian characters. It can also be used for annotating other kinds of text, but this usage is less common.
ruby HtmlElement,
/// The `<s>` HTML element renders text with a strikethrough, or a line through it. Use the `<s>` element to represent things that are no longer relevant or no longer accurate. However, `<s>` is not appropriate when indicating document edits; for that, use the del and ins elements, as appropriate.
s HtmlElement,
/// The `<samp>` HTML element is used to enclose inline text which represents sample (or quoted) output from a computer program. Its contents are typically rendered using the browser's default monospaced font (such as Courier or Lucida Console).
samp HtmlElement,
/// The `<small>` HTML element represents side-comments and small print, like copyright and legal text, independent of its styled presentation. By default, it renders text within it one font-size smaller, such as from small to x-small.
small HtmlElement,
/// The `<span>` HTML element is a generic inline container for phrasing content, which does not inherently represent anything. It can be used to group elements for styling purposes (using the class or id attributes), or because they share attribute values, such as lang. It should be used only when no other semantic element is appropriate. `<span>` is very much like a div element, but div is a block-level element whereas a `<span>` is an inline element.
span HtmlSpanElement,
/// The `<strong>` HTML element indicates that its contents have strong importance, seriousness, or urgency. Browsers typically render the contents in bold type.
strong HtmlElement,
/// The `<sub>` HTML element specifies inline text which should be displayed as subscript for solely typographical reasons. Subscripts are typically rendered with a lowered baseline using smaller text.
sub HtmlElement,
/// The `<sup>` HTML element specifies inline text which is to be displayed as superscript for solely typographical reasons. Superscripts are usually rendered with a raised baseline using smaller text.
sup HtmlElement,
/// The `<time>` HTML element represents a specific period in time. It may include the datetime attribute to translate dates into machine-readable format, allowing for better search engine results or custom features such as reminders.
time HtmlTimeElement,
/// The `<u>` HTML element represents a span of inline text which should be rendered in a way that indicates that it has a non-textual annotation. This is rendered by default as a simple solid underline, but may be altered using CSS.
u HtmlElement,
/// The `<var>` HTML element represents the name of a variable in a mathematical expression or a programming context. It's typically presented using an italicized version of the current typeface, although that behavior is browser-dependent.
var HtmlElement,
/// The `<wbr>` HTML element represents a word break opportunity—a position within text where the browser may optionally break a line, though its line-breaking rules would not otherwise create a break at that location.
#[void]
wbr HtmlElement,
// ==========================
// Image and multimedia
// ==========================
/// The `<area>` HTML element defines an area inside an image map that has predefined clickable areas. An image map allows geometric areas on an image to be associated with Hyperlink.
#[void]
area HtmlAreaElement,
/// The `<audio>` HTML element is used to embed sound content in documents. It may contain one or more audio sources, represented using the src attribute or the source element: the browser will choose the most suitable one. It can also be the destination for streamed media, using a MediaStream.
audio HtmlAudioElement,
/// The `<img>` HTML element embeds an image into the document.
#[void]
img HtmlImageElement,
/// The `<map>` HTML element is used with area elements to define an image map (a clickable link area).
map HtmlMapElement,
/// The `<track>` HTML element is used as a child of the media elements, audio and video. It lets you specify timed text tracks (or time-based data), for example to automatically handle subtitles. The tracks are formatted in WebVTT format (.vtt files) — Web Video Text Tracks.
#[void]
track HtmlTrackElement,
/// The `<video>` HTML element embeds a media player which supports video playback into the document. You can use `<video>` for audio content as well, but the audio element may provide a more appropriate user experience.
video HtmlVideoElement,
// ==========================
// Embedded Content
// ==========================
/// The `<embed>` HTML element embeds external content at the specified point in the document. This content is provided by an external application or other source of interactive content such as a browser plug-in.
#[void]
embed HtmlEmbedElement,
/// The `<iframe>` HTML element represents a nested browsing context, embedding another HTML page into the current one.
iframe HtmlIFrameElement,
/// The `<object>` HTML element represents an external resource, which can be treated as an image, a nested browsing context, or a resource to be handled by a plugin.
object HtmlObjectElement,
/// The `<param>` HTML element defines parameters for an object element.
#[void]
param HtmlParamElement,
/// The `<picture>` HTML element contains zero or more source elements and one img element to offer alternative versions of an image for different display/device scenarios.
picture HtmlPictureElement,
/// The `<portal>` HTML element enables the embedding of another HTML page into the current one for the purposes of allowing smoother navigation into new pages.
portal HtmlElement,
/// The `<source>` HTML element specifies multiple media resources for the picture, the audio element, or the video element. It is an empty element, meaning that it has no content and does not have a closing tag. It is commonly used to offer the same media content in multiple file formats in order to provide compatibility with a broad range of browsers given their differing support for image file formats and media file formats.
#[void]
source HtmlSourceElement,
// ==========================
// SVG and MathML
// ==========================
/// The svg element is a container that defines a new coordinate system and viewport. It is used as the outermost element of SVG documents, but it can also be used to embed an SVG fragment inside an SVG or HTML document.
svg SvgElement,
/// The top-level element in MathML is `<math>.` Every valid MathML instance must be wrapped in `<math>` tags. In addition you must not nest a second `<math>` element in another, but you can have an arbitrary number of other child elements in it.
math HtmlElement,
// ==========================
// Scripting
// ==========================
/// Use the HTML `<canvas>` element with either the canvas scripting API or the WebGL API to draw graphics and animations.
canvas HtmlCanvasElement,
/// The `<noscript>` HTML element defines a section of HTML to be inserted if a script type on the page is unsupported or if scripting is currently turned off in the browser.
noscript HtmlElement,
/// The `<script>` HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code. The `<script>` element can also be used with other languages, such as WebGL's GLSL shader programming language and JSON.
script HtmlScriptElement,
// ==========================
// Demarcating Edits
// ==========================
/// The `<del>` HTML element represents a range of text that has been deleted from a document. This can be used when rendering "track changes" or source code diff information, for example. The ins element can be used for the opposite purpose: to indicate text that has been added to the document.
del HtmlModElement,
/// The `<ins>` HTML element represents a range of text that has been added to a document. You can use the del element to similarly represent a range of text that has been deleted from the document.
ins HtmlElement,
// ==========================
// Table Content
// ==========================
/// The `<caption>` HTML element specifies the caption (or title) of a table.
caption HtmlTableCaptionElement,
/// The `<col>` HTML element defines a column within a table and is used for defining common semantics on all common cells. It is generally found within a colgroup element.
#[void]
col HtmlTableColElement,
/// The `<colgroup>` HTML element defines a group of columns within a table.
colgroup HtmlTableColElement,
/// The `<table>` HTML element represents tabular data — that is, information presented in a two-dimensional table comprised of rows and columns of cells containing data.
table HtmlTableElement,
/// The `<tbody>` HTML element encapsulates a set of table rows (tr elements), indicating that they comprise the body of the table (table).
tbody HtmlTableSectionElement,
/// The `<td>` HTML element defines a cell of a table that contains data. It participates in the table model.
td HtmlTableCellElement,
/// The `<tfoot>` HTML element defines a set of rows summarizing the columns of the table.
tfoot HtmlTableSectionElement,
/// The `<th>` HTML element defines a cell as header of a group of table cells. The exact nature of this group is defined by the scope and headers attributes.
th HtmlTableCellElement,
/// The `<thead>` HTML element defines a set of rows defining the head of the columns of the table.
thead HtmlTableSectionElement,
/// The `<tr>` HTML element defines a row of cells in a table. The row's cells can then be established using a mix of td (data cell) and th (header cell) elements.
tr HtmlTableRowElement,
// ==========================
// Forms
// ==========================
/// The `<button>` HTML element represents a clickable button, used to submit forms or anywhere in a document for accessible, standard button functionality.
button HtmlButtonElement,
/// The `<datalist>` HTML element contains a set of option elements that represent the permissible or recommended options available to choose from within other controls.
datalist HtmlDataListElement,
/// The `<fieldset>` HTML element is used to group several controls as well as labels (label) within a web form.
fieldset HtmlFieldSetElement,
/// The `<form>` HTML element represents a document section containing interactive controls for submitting information.
form HtmlFormElement,
/// The `<input>` HTML element is used to create interactive controls for web-based forms in order to accept data from the user; a wide variety of types of input data and control widgets are available, depending on the device and user agent. The `<input>` element is one of the most powerful and complex in all of HTML due to the sheer number of combinations of input types and attributes.
#[void]
input HtmlInputElement,
/// The `<label>` HTML element represents a caption for an item in a user interface.
label HtmlLabelElement,
/// The `<legend>` HTML element represents a caption for the content of its parent fieldset.
legend HtmlLegendElement,
/// The `<meter>` HTML element represents either a scalar value within a known range or a fractional value.
meter HtmlMeterElement,
/// The `<optgroup>` HTML element creates a grouping of options within a select element.
optgroup HtmlOptGroupElement,
/// The `<option>` HTML element is used to define an item contained in a select, an optgroup, or a datalist element. As such, `<option>` can represent menu items in popups and other lists of items in an HTML document.
option[_] HtmlOptionElement,
/// The `<output>` HTML element is a container element into which a site or app can inject the results of a calculation or the outcome of a user action.
output HtmlOutputElement,
/// The `<progress>` HTML element displays an indicator showing the completion progress of a task, typically displayed as a progress bar.
progress HtmlProgressElement,
/// The `<select>` HTML element represents a control that provides a menu of options:
select HtmlSelectElement,
/// The `<textarea>` HTML element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.
textarea HtmlTextAreaElement,
// ==========================
// Interactive elements
// ==========================
/// The `<details>` HTML element creates a disclosure widget in which information is visible only when the widget is toggled into an "open" state. A summary or label must be provided using the summary element.
details HtmlDetailsElement,
/// The `<dialog>` HTML element represents a dialog box or other interactive component, such as a dismissible alert, inspector, or subwindow.
dialog HtmlDialogElement,
/// The `<menu>` HTML element is a semantic alternative to ul. It represents an unordered list of items (represented by li elements), each of these represent a link or other command that the user can activate.
menu HtmlMenuElement,
/// The `<summary>` HTML element specifies a summary, caption, or legend for a details element's disclosure box. Clicking the `<summary>` element toggles the state of the parent `<details>` element open and closed.
summary HtmlElement,
// ==========================
// Web Components
// ==========================
/// The `<slot>` HTML element—part of the Web Components technology suite—is a placeholder inside a web component that you can fill with your own markup, which lets you create separate DOM trees and present them together.
slot HtmlSlotElement,
/// The `<template>` HTML element is a mechanism for holding HTML that is not to be rendered immediately when a page is loaded but may be instantiated subsequently during runtime using JavaScript.
template HtmlTemplateElement,
];