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
use crate::def_attribute;
def_attribute!(
/// The `color` attribute lets you specify the color of the text.
///
/// You can learn about the syntax of this attribute in [`Color Syntax`](crate::_docs::color_syntax).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// color: "green",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
///
/// Another example showing [inheritance](crate::_docs::inheritance):
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// rect {
/// color: "blue",
/// label {
/// "Hello, World!"
/// }
/// }
/// )
/// }
/// ```
color,
/// You can specify the size of the text using `font_size`.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// font_size: "50",
/// "Hellooooo!"
/// }
/// )
/// }
/// ```
font_size,
/// With the `font_family` you can specify what font you want to use for the inner text.
///
/// Check out the [custom font example](https://github.com/marc2332/freya/blob/main/examples/custom_font.rs)
/// to see how you can load your own fonts.
///
/// <!-- TODO: Example of checking if a font exists with skia_safe -->
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// font_family: "Inter",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
font_family,
/// You can choose a style for a text using the `font_style` attribute.
///
/// Accepted values:
///
/// - `upright` (default)
/// - `italic`
/// - `oblique`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// font_style: "italic",
/// "Hello, italic World!"
/// }
/// )
/// }
/// ```
///
/// You can also specify multiple fonts in order of priority, if one is not found it will fallback to the next one.
///
/// Example:
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// font_family: "DoesntExist Font, Impact",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
font_style,
/// You can choose a weight for text using the `font_weight` attribute.
///
/// Accepted values:
///
/// - `invisible`
/// - `thin`
/// - `extra-light`
/// - `light`
/// - `normal` (default)
/// - `medium`
/// - `semi-bold`
/// - `bold`
/// - `extra-bold`
/// - `black`
/// - `extra-black`
/// - `50`
/// - `100`
/// - `200`
/// - `300`
/// - `400`
/// - `500`
/// - `600`
/// - `700`
/// - `800`
/// - `900`
/// - `950`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// font_weight: "bold",
/// "Hello, bold World!"
/// }
/// )
/// }
/// ```
font_weight,
/// You can choose a width for a text using the `font_width` attribute.
///
/// ⚠️ Only fonts with variable widths will be affected.
///
/// Accepted values:
///
/// - `ultra-condensed`
/// - `extra-condensed`
/// - `condensed`
/// - `normal` (default)
/// - `semi-expanded`
/// - `expanded`
/// - `extra-expanded`
/// - `ultra-expanded`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// font_width: "ultra-expanded",
/// "Hello, wide World!"
/// }
/// )
/// }
/// ```
font_width,
/// You can change the alignment of the text using the `text_align` attribute.
///
/// Accepted values:
///
/// - `center`
/// - `end`
/// - `justify`
/// - `left` (default)
/// - `right`
/// - `start`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// text_align: "right",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
text_align,
/// ### line_height
///
/// Specify the height of the lines of the text.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// line_height: "3",
/// "Hello, World! \n Hello, again!"
/// }
/// )
/// }
/// ```
line_height,
/// Specify the shadow of a text.
///
/// Syntax: `<x> <y> <size> <color>`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// text_shadow: "0 18 12 rgb(0, 0, 0)",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
text_shadow,
/// Determines the amount of lines that the text can have. It has unlimited lines by default.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// "Hello, World! \n Hello, World! \n Hello, world!" // Will show all three lines
/// }
/// label {
/// max_lines: "2",
/// "Hello, World! \n Hello, World! \n Hello, world!" // Will only show two lines
/// }
/// )
/// }
/// ```
max_lines,
/// Specify the decoration in a text.
///
/// Accepted values:
///
/// - `underline`
/// - `line-through`
/// - `overline`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// decoration: "line-through",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
decoration,
/// Specify the decoration's style in a text.
///
/// Accepted values:
///
/// - `solid` (default)
/// - `double`
/// - `dotted`
/// - `dashed`
/// - `wavy`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// decoration: "line-through",
/// decoration_style: "dotted",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
decoration_style,
/// Specify the decoration’s color in a text.
///
/// You can learn about the syntax of this attribute in [`Color Syntax`](crate::_docs::color_syntax).
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// decoration: "line-through",
/// decoration_color: "orange",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
decoration_color,
/// Determines how text is treated when it exceeds its [`max_lines`](#max_lines) count. By default uses the `clip` mode, which will cut off any overflowing text, with `ellipsis` mode it will show `...` at the end.
///
/// Accepted values:
///
/// - `clip` (default): Simply cut the text.
/// - `ellipsis`: Show `…`.
/// - `[custom-value]: Show a custom value.
///
/// ### Ellipsis example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// max_lines: "3",
/// text_overflow: "ellipsis",
/// "Looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong text"
/// }
/// )
/// }
/// ```
///
/// ### Custom value example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// max_lines: "3",
/// text_overflow: ".......too long.",
/// "Looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong text"
/// }
/// )
/// }
/// ```
text_overflow,
/// Specify the spacing between characters of the text.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// letter_spacing: "10",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
letter_spacing,
/// Specify the spacing between words of the text.
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// word_spacing: "10",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
word_spacing,
/// Specify the text height behavior.
///
/// Accepted values:
///
/// - `disable-all` (default)
/// - `all`
/// - `disable-first-ascent`
/// - `disable-least-ascent`
///
/// ### Example
///
/// ```rust, no_run
/// # use freya::prelude::*;
/// fn app() -> Element {
/// rsx!(
/// label {
/// text_height: "disable-all",
/// "Hello, World!"
/// }
/// )
/// }
/// ```
text_height,
);