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
//! Create html [attributes][0]
//!
//! [0]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes
use crate::vdom;
use crate::vdom::Attribute;
use crate::Event;
pub use attribute_macros::*;
pub use attribute_value::AttributeValue;
pub use jss::Value;
pub use listener::Listener;
pub use special::{key, replace, skip, Special};
pub use style::Style;
#[macro_use]
mod attribute_macros;
mod attribute_value;
mod listener;
mod special;
mod style;
/// create a style attribute
/// # Examples
/// ```rust
/// use sauron::prelude::*;
/// use sauron::html::attributes::style;
///
/// let flex:Attribute<()> = style("display", "flex");
/// ```
pub fn style<MSG>(
style_name: impl ToString,
value: impl Into<Value>,
) -> Attribute<MSG> {
mt_dom::attr(
"style",
AttributeValue::from_styles([Style::new(style_name, value.into())]),
)
}
/// A helper function which creates a style attribute by assembling the tuples into a string for the style value.
/// # Example
/// ```rust
/// use sauron::prelude::*;
///
/// let html:Node<()> = div(vec![styles([("display", "flex"), ("flex-direction", "row")])], vec![]);
/// ```
/// is the same way of writing
/// ```rust
/// use sauron::prelude::*;
///
/// let html: Node<()> = div(vec![style!{"display":"flex","flex-direction":"row"}],vec![]);
/// ```
pub fn styles<MSG>(
pairs: impl IntoIterator<Item = (impl ToString, impl Into<Value>)>,
) -> Attribute<MSG> {
let styles = pairs.into_iter().map(|(key, value)| {
Style::new(key.to_string(), Into::<Value>::into(value))
});
mt_dom::attr("style", AttributeValue::from_styles(styles))
}
/// A helper function to build styles by accepting pairs
pub fn styles_values<MSG>(
pairs: impl IntoIterator<Item = (impl ToString, impl Into<Value>)>,
) -> Attribute<MSG> {
let styles = pairs
.into_iter()
.map(|(key, value)| Style::new(key.to_string(), value));
mt_dom::attr("style", AttributeValue::from_styles(styles))
}
/// A helper function which creates a style attribute by assembling only the parts that passed the
/// boolean flag.
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let is_active = true;
/// let display:Attribute<()> = styles_flag([
/// ("display", "block", is_active),
/// ("display", "none", !is_active),
/// ]);
/// ```
/// This could also be written as
/// ```rust
/// use sauron::prelude::*;
///
/// let is_active = true;
/// let display:Attribute<()> =
/// styles([("display", if is_active { "block" }else{ "none" })]);
/// ```
pub fn styles_flag<MSG>(
trio: impl IntoIterator<Item = (impl ToString, impl Into<Value>, bool)>,
) -> Attribute<MSG> {
let styles = trio.into_iter().filter_map(|(key, value, flag)| {
if flag {
Some(Style::new(key, value))
} else {
None
}
});
mt_dom::attr("style", AttributeValue::from_styles(styles))
}
/// A helper function which takes an array of tuple of class and a flag. The final class is
/// assembled using only the values that has a flag which evaluates to true.
/// # Examples
/// ```rust
/// use sauron::prelude::*;
/// let is_hidden = true;
/// let has_error = true;
///
/// let line:Attribute<()> = classes_flag([
/// ("dashed", is_hidden),
/// ("error", has_error),
/// ]);
/// ```
pub fn classes_flag<MSG>(
pair: impl IntoIterator<Item = (impl ToString, bool)>,
) -> Attribute<MSG> {
let class_list = pair.into_iter().filter_map(|(class, flag)| {
if flag {
Some(class.to_string())
} else {
None
}
});
classes(class_list)
}
/// a helper function to add multiple classes to a node
/// # Examples
///
/// ```rust
/// use sauron::prelude::*;
///
/// let html: Node<()> =
/// div(vec![classes(["dashed", "error"])], vec![]);
/// ```
pub fn classes<MSG>(
class_list: impl IntoIterator<Item = impl ToString>,
) -> Attribute<MSG> {
let class_values = class_list
.into_iter()
.map(|v| AttributeValue::from_value(Value::from(v.to_string())));
Attribute::with_multiple_values(None, "class", class_values)
}
/// return a class attribute where the classnames are transformed with
/// namespace
/// # Example:
/// ```rust
/// use sauron::html::attributes::class_namespaced;
/// use sauron::Attribute;
/// use sauron::html::attributes::class;
///
/// let component = "fui";
/// let expected: Attribute<()> = class("fui__border".to_string());
/// assert_eq!(expected, class_namespaced(component, "border"));
///
/// let expected: Attribute<()> =
/// class("fui__border fui__corner".to_string());
/// assert_eq!(expected, class_namespaced(component, "border corner"));
/// ```
pub fn class_namespaced<MSG>(
namespace: impl ToString,
class_names: impl ToString,
) -> vdom::Attribute<MSG> {
class(jss::class_namespaced(namespace, class_names))
}
/// return a class namespaced with flag
/// # Examples
/// ```rust
/// use sauron::prelude::*;
/// use sauron::html::attributes::classes_flag_namespaced;
///
/// let component = "fui";
/// let is_border = true;
/// let is_corner = false;
///
/// let expected: Attribute<()> = class("fui__border".to_string());
/// assert_eq!(expected, classes_flag_namespaced(component, [("border", is_border),("corner",
/// is_corner)]));
/// ```
pub fn classes_flag_namespaced<MSG>(
namespace: impl ToString,
pair: impl IntoIterator<Item = (impl ToString, bool)>,
) -> vdom::Attribute<MSG> {
let class_list = pair.into_iter().filter_map(|(class_name, flag)| {
if flag {
Some(jss::class_namespaced(namespace.to_string(), class_name))
} else {
None
}
});
classes(class_list)
}
/// A helper function for setting attributes with no values such as checked
/// in checkbox input type
/// This is best called to be appended to the node since this
/// returns an array of attributes which doesn't play well with the others
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let is_checked = true;
/// let html: Node<()> =
/// input(vec![r#type("checkbox")], vec![]).add_attributes(attrs_flag(vec![(
/// "checked",
/// "checked",
/// is_checked,
/// )]));
/// ```
pub fn attrs_flag<MSG>(
trio: impl IntoIterator<Item = (&'static str, impl Into<Value>, bool)>,
) -> impl IntoIterator<Item = Attribute<MSG>> {
trio.into_iter().filter_map(|(key, value, flag)| {
if flag {
Some(attr(key, value.into()))
} else {
None
}
})
}
/// Set the attribute of this element if value is Some, empty attribute otherwise
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let width = Some(10);
/// let html: Node<()> = button(vec![maybe_attr("width", width)], vec![]);
/// let expected = r#"<button width="10"></button>"#;
/// assert_eq!(expected, html.render_to_string());
///
/// let width = None::<usize>;
/// let html: Node<()> = button(vec![maybe_attr("width", width)], vec![]);
/// let expected = r#"<button></button>"#;
/// assert_eq!(expected, html.render_to_string());
/// ```
pub fn maybe_attr<MSG>(
name: vdom::AttributeName,
value: Option<impl Into<Value>>,
) -> Attribute<MSG> {
if let Some(value) = value {
attr(name, value)
} else {
empty_attr()
}
}
/// set the checked value, used checkbox and radio buttons
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let html: Node<()> =
/// input(vec![r#type("checkbox"), checked(true)], vec![]);
/// ```
pub fn checked<MSG>(is_checked: bool) -> Attribute<MSG> {
if is_checked {
#[cfg(not(feature = "with-dom"))]
{
attr("checked", "checked")
}
#[cfg(feature = "with-dom")]
{
attr("checked", true)
}
} else {
empty_attr()
}
}
/// set whether an element is disabled or not
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let html: Node<()> =
/// input(vec![r#type("checkbox"), disabled(true)], vec![]);
/// ```
pub fn disabled<MSG>(is_disabled: bool) -> Attribute<MSG> {
if is_disabled {
attr("disabled", true)
} else {
empty_attr()
}
}
/// set the inner html of this element without comparing in the diff
/// this always sets the value
/// This is for optimization purposes
/// and will lead to some hacks in the implementation
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let html:Node<()> =
/// div(vec![inner_html("<p>This is a paragraph <b>injected</b> into a <strong>div</strong> via <i>inner_html</i></p>")], vec![]);
/// ```
pub fn inner_html<V, MSG>(inner_html: V) -> Attribute<MSG>
where
V: Into<Value> + Clone,
{
mt_dom::attr(
"inner_html",
AttributeValue::function_call(inner_html.into()),
)
}
/// focus the html element
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let editor:Node<()> = textarea(vec![focus(true)], vec![]);
/// ```
pub fn focus<MSG>(is_focus: bool) -> Attribute<MSG> {
attr("focus", is_focus)
}
/// a utility function to convert simple value into attribute
/// # Examples
/// ```rust
/// use sauron::prelude::*;
///
/// let data_id: Attribute<()> = attr("data-id", 42);
/// ```
pub fn attr<MSG, V: Into<Value>>(att: &'static str, v: V) -> Attribute<MSG> {
mt_dom::attr(att, AttributeValue::from_value(v.into()))
}
/// a utility function to return create an empty attr, useful for cases where branch expression
/// need to return an attribute which otherwise it can not produce
/// example:
/// ```rust
/// use sauron::prelude::*;
/// use sauron::html::attributes::title;
///
/// let img_title = Some("this is the image");
/// let result: Attribute<()> = if let Some(img_title) = img_title{
/// title(img_title)
/// }
/// else{
/// empty_attr()
/// };
/// assert_eq!(title("this is the image"), result);
/// ```
pub fn empty_attr<MSG>() -> Attribute<MSG> {
mt_dom::attr("", AttributeValue::Empty)
}
/// merge the plain values
#[doc(hidden)]
pub(crate) fn merge_plain_attributes_values<MSG>(
attr_values: &[&AttributeValue<MSG>],
) -> Option<String> {
let plain_values: Vec<String> = attr_values
.iter()
.flat_map(|att_value| match att_value {
AttributeValue::Simple(simple) => Some(simple.to_string()),
AttributeValue::FunctionCall(fvalue) => Some(fvalue.to_string()),
_ => None,
})
.collect();
if !plain_values.is_empty() {
Some(plain_values.join(" "))
} else {
None
}
}
/// merge the styles
#[doc(hidden)]
pub(crate) fn merge_styles_attributes_values<MSG>(
attr_values: &[&AttributeValue<MSG>],
) -> Option<String> {
use std::fmt::Write;
let styles_values: Vec<String> = attr_values
.iter()
.flat_map(|att_value| match att_value {
AttributeValue::Style(styles) => {
let mut style_str = String::new();
styles.iter().for_each(|s| {
write!(style_str, "{};", s).expect("must write")
});
Some(style_str)
}
_ => None,
})
.collect();
if !styles_values.is_empty() {
Some(styles_values.join(" "))
} else {
None
}
}
/// The Attributes partition into 4 different types
pub struct SegregatedAttributes<'a, MSG> {
/// the listeners of the event listeners
pub listeners: Vec<&'a Listener<Event, MSG>>,
/// plain attribute values
pub plain_values: Vec<&'a AttributeValue<MSG>>,
/// style attribute values
pub styles: Vec<&'a AttributeValue<MSG>>,
/// function calls
pub function_calls: Vec<&'a AttributeValue<MSG>>,
}
/// returns (listeners, plain_attribtues, function_calls)
#[doc(hidden)]
pub(crate) fn partition_callbacks_from_plain_styles_and_func_calls<MSG>(
attr: &Attribute<MSG>,
) -> SegregatedAttributes<MSG> {
let mut listeners = vec![];
let mut plain_values = vec![];
let mut styles = vec![];
let mut function_calls = vec![];
for av in attr.value() {
match av {
AttributeValue::Simple(_plain) => {
plain_values.push(av);
}
AttributeValue::FunctionCall(_call) => {
function_calls.push(av);
}
AttributeValue::Style(_) => {
styles.push(av);
}
AttributeValue::EventListener(cb) => {
listeners.push(cb);
}
_ => (),
}
}
SegregatedAttributes {
listeners,
plain_values,
styles,
function_calls,
}
}