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
use crate::def_attribute;
def_attribute!(
/// Specify the height for the given element.
///
/// See syntax in [`Size Units`](crate::_docs::size_unit).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// height: "50",
/// width: "15",
/// }
/// )
/// }
/// ```
height,
/// Specify the width for the given element.
///
/// See syntax in [`Size Units`](crate::_docs::size_unit).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// height: "50",
/// width: "15",
/// }
/// )
/// }
/// ```
width,
/// Specify a minimum width for the given element.
/// This can be useful if you use it alongside a percentage for the target size.
///
/// See syntax for [`Size Units`](crate::_docs::size_unit).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// min_width: "100",
/// min_height: "100",
/// width: "50%",
/// height: "50%",
/// }
/// )
/// }
/// ```
min_width,
/// Specify a minimum height for the given element.
/// This can be useful if you use it alongside a percentage for the target size.
///
/// See syntax for [`Size Units`](crate::_docs::size_unit).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// min_width: "100",
/// min_height: "100",
/// width: "50%",
/// height: "50%",
/// }
/// )
/// }
/// ```
min_height,
/// Specify a maximum width for the given element.
///
/// See syntax for [`Size Units`](crate::_docs::size_unit).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// max_width: "50%",
/// width: "500",
/// height: "500",
/// }
/// )
/// }
/// ```
max_width,
/// Specify a maximum height for the given element.
///
/// See syntax for [`Size Units`](crate::_docs::size_unit).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// max_height: "50%",
/// width: "500",
/// height: "500",
/// }
/// )
/// }
/// ```
max_height,
/// Specify the percentage of width to be visible.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// visible_width: "50%", // 250
/// width: "500",
/// height: "500",
/// }
/// )
/// }
/// ```
visible_width,
/// Specify the percentage of height to be visible.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// background: "red",
/// visible_height: "50%", // 250
/// width: "500",
/// height: "500",
/// }
/// )
/// }
/// ```
visible_height,
/// Specify the margin of an element.
/// You can do so by four different ways, just like in CSS.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// margin: "25", // 25 in all sides
/// margin: "100 50", // 100 in top and bottom, and 50 in left and right
/// margin: "2 15 25", // 2 in top, 15 in left and right, and 25 in bottom
/// margin: "5 7 3 9" // 5 in top, 7 in right, 3 in bottom and 9 in left
/// }
/// )
/// }
/// ```
margin,
/// Specify the inner paddings of an element. You can do so by four different ways, just like in CSS.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// padding: "25", // 25 in all sides
/// padding: "100 50", // 100 in top and bottom, and 50 in left and right
/// padding: "2 15 25", // 2 in top, 15 in left and right, and 25 in bottom
/// padding: "5 7 3 9" // 5 in top, 7 in right, 3 in bottom and 9 in left
/// }
/// )
/// }
/// ```
padding,
/// Specify how you want the element to be positioned inside it's parent area.
///
/// Accepted values:
///
/// - `stacked` (default)
/// - `absolute` (Floating element relative to the parent element)
/// - `global` (Floating element relative to the window)
///
/// When using the `absolute` or `global` modes, you can also combine them with the following attributes:
///
/// - `position_top`
/// - `position_right`
/// - `position_bottom`
/// - `position_left`
///
/// These only support pixels.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// rect {
/// position: "absolute",
/// position_bottom: "15",
/// position_right: "15",
/// background: "black",
/// width: "100",
/// height: "100",
/// }
/// }
/// )
/// }
/// ```
position,
/// Specify the top position of an element when using `position: "absolute"` or `position: "global"`.
/// This supports pixels only.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// rect {
/// position: "absolute",
/// position_top: "15",
/// position_left: "15",
/// background: "black",
/// width: "100",
/// height: "100",
/// }
/// }
/// )
/// }
/// ```
position_top,
/// Specify the right position of an element when using `position: "absolute"` or `position: "global"`.
/// This supports pixels only.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// rect {
/// position: "absolute",
/// position_top: "15",
/// position_right: "15",
/// background: "black",
/// width: "100",
/// height: "100",
/// }
/// }
/// )
/// }
/// ```
position_right,
/// Specify the bottom position of an element when using `position: "absolute"` or `position: "global"`.
/// This supports pixels only.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// rect {
/// position: "absolute",
/// position_bottom: "15",
/// position_right: "15",
/// background: "black",
/// width: "100",
/// height: "100",
/// }
/// }
/// )
/// }
/// ```
position_bottom,
/// Specify the left position of an element when using `position: "absolute"` or `position: "global"`.
/// This supports pixels only.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// rect {
/// position: "absolute",
/// position_bottom: "15",
/// position_left: "15",
/// background: "black",
/// width: "100",
/// height: "100",
/// }
/// }
/// )
/// }
/// ```
position_left,
/// Control how the inner elements stack.
///
/// Accepted values:
///
/// - `vertical` (default)
/// - `horizontal`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// direction: "vertical",
/// rect {
/// width: "100%",
/// height: "50%",
/// background: "red"
/// },
/// rect {
/// width: "100%",
/// height: "50%",
/// background: "green"
/// }
/// }
/// )
/// }
/// ```
direction,
/// Specify how you want the automatic (e.g `width: auto`) bounds in the cross axis to be constrained for the inner elements.
///
/// Accepted values:
///
/// - `normal` (default): Uses parent bounds.
/// - `fit`: Uses parent bounds but later shrunks to the size of the biggest element inside.
/// - `flex`: Marks the container as flex container, children of this element will be able to use `size`/`size(n)` in their `width` and `height` attributes.
///
///
/// ### `fit`
///
/// The `fit` mode will allow the inner elements using `width: fill-min` to expand to the biggest element inside this element.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// content: "fit",
/// height: "100%",
/// rect {
/// width: "fill-min", // Will have a width of 300px
/// height: "25%",
/// background: "red",
/// }
/// rect {
/// width: "150", // Will have a width of 150px
/// height: "25%",
/// background: "green",
/// }
/// rect {
/// width: "fill-min", // Will have a width of 300px
/// height: "25%",
/// background: "blue",
/// }
/// rect {
/// width: "300", // Biggest element, will have a width of 300px
/// height: "25%",
/// background: "black",
/// }
/// }
/// )
/// }
/// ```
content,
/// ### main_align
///
/// Control how the inner elements are positioned inside the element. You can combine it with the `direction` attribute to create complex flows.
///
/// Accepted values for `main_align`:
///
/// - `start` (default): At the begining of the axis
/// - `center`: At the center of the axis
/// - `end`: At the end of the axis
/// - `space-between`(only for `main_align`): Distributed among the available space
/// - `space-around` (only for `main_align`): Distributed among the available space with small margins in the sides
/// - `space-evenly` (only for `main_align`): Distributed among the available space with the same size of margins in the sides and in between the elements.
///
/// When using the `vertical` direction it uses the Y axis and in `horizontal` direction it uses the X axis.
///
/// Example on how to center the inner elements in the main axis:
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// main_align: "center",
/// rect {
/// width: "50%",
/// height: "50%",
/// background: "red"
/// },
/// }
/// )
/// }
/// ```
main_align,
/// ### cross_align
///
/// Control how the inner elements are positioned inside the element in the axis perpendicular to the direction.
///
/// Accepted values:
///
/// - `start` (default): At the begining of the axis (same as in `main_align`)
/// - `center`: At the center of the axis (same as in `main_align`)
/// - `end`: At the end of the axis (same as in `main_align`)
///
/// When using the `vertical` direction it uses the X axis and in `horizontal` direction it uses the Y axis.
///
/// Example on how to center the inner elements in the cross axis:
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "100%",
/// height: "100%",
/// cross_align: "center",
/// rect {
/// width: "50%",
/// height: "50%",
/// background: "red"
/// },
/// }
/// )
/// }
/// ```
cross_align,
/// Specify a space between the inner elements. Think it as a margin for every element but defined by its parent.
/// It only applies to the side of the direction.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// direction: "vertical",
/// spacing: "20",
/// // Not before
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// }
/// // There will be a space between these two elements of 20 pixels
/// rect {
/// width: "100",
/// height: "100",
/// background: "blue",
/// }
/// // Here as well
/// rect {
/// width: "100",
/// height: "100",
/// background: "green",
/// }
/// // But not after
/// }
/// )
/// }
/// ```
spacing,
/// Specify how overflow should be handled.
///
/// Accepted values:
///
/// - `clip`
/// - `none`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// overflow: "clip",
/// width: "100",
/// height: "100%",
/// rect {
/// width: "500",
/// height: "100%",
/// background: "red",
/// }
/// }
/// )
/// }
/// ```
overflow,
/// Moves the content inside of the container horizontally by the specified pixel amount.
/// This attribute only supports pixels.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "200",
/// height: "200",
/// background: "gray",
/// offset_x: "20", // Shifts content 20 pixels to the right
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// }
/// }
/// )
/// }
/// ```
offset_x,
/// Moves the content inside of the container vertically by the specified pixel amount.
/// This attribute only supports pixels.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "200",
/// height: "200",
/// background: "gray",
/// offset_y: "30", // Shifts content 30 pixels down
/// rect {
/// width: "100",
/// height: "100",
/// background: "red",
/// }
/// }
/// )
/// }
/// ```
offset_y,
/// Controls the stacking order of elements on the z-axis.
///
/// In Freya, elements are stacked in the order they appear in the DOM, with later elements
/// appearing on top of earlier ones. The `layer` attribute allows you to explicitly control
/// this stacking behavior.
///
/// Lower layer values position elements higher in the stack (visually on top), while higher
/// values position elements lower in the stack (visually behind).
///
/// A value of 0 maintains the default stacking order, effectively keeping the layer the same.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// width: "500",
/// height: "500",
/// // Using an image as the base element
/// image {
/// width: "300",
/// height: "200",
/// image_data: static_bytes(include_bytes!("../_docs/rust_logo.png")),
/// }
/// // Overlay on top of the image using absolute positioning
/// rect {
/// position: "absolute",
/// position_top: "0",
/// position_left: "0",
/// width: "300",
/// height: "200",
/// background: "rgba(0, 0, 255, 0.5)", // Semi-transparent blue overlay
/// layer: "-1", // Ensures this is on top
/// }
/// }
/// )
/// }
/// ```
layer,
);