Struct freya::elements::label

pub struct label;

label simply let’s you display some text.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            "Hello World"
        }
    )
}

Implementations

impl label

pub const color: (&'static str, Option<&'static str>, bool) = _

color

The color attribute let’s you specify the color of the text.

You can learn about the syntax of this attribute in Color Syntax.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            color: "green",
            "Hello, World!"
        }
    )
}

Another example showing inheritance:

fn app(cx: Scope) -> Element {
    render!(
        rect {
            color: "blue",
            label {
                "Hello, World!"
            }
        }
    )
}

pub const text_shadow: (&'static str, Option<&'static str>, bool) = _

text_shadow

Specify the shadow of a text.

Syntax: <x> <y> <size> <color>

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            text_shadow: "0 18 12 rgb(0, 0, 0)",
            "Hello, World!"
        }
    )
}

pub const height: (&'static str, Option<&'static str>, bool) = _

width and height

Specify the width and height for the given element.

See syntax in Size Units.

Example:

fn app(cx: Scope) -> Element {
    render!(
        rect {
            background: "red",
            width: "15",
            height: "50",
        }
    )
}

pub const width: (&'static str, Option<&'static str>, bool) = _

pub const font_size: (&'static str, Option<&'static str>, bool) = _

font_size

You can specify the size of the text using font_size.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            font_size: "50",
            "Hellooooo!"
        }
    )
}

pub const font_family: (&'static str, Option<&'static str>, bool) = _

font_family

With the font_family you can specify what font do you want to use for the inner text.

Limitation: Only fonts installed in the system are supported for now.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            font_family: "Inter",
            "Hello, World!"
        }
    )
}

pub const font_style: (&'static str, Option<&'static str>, bool) = _

font_style

You can choose a style for a text using the font_style attribute.

Accepted values: upright (default), italic and oblique.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            font_style: "italic",
            "Hello, World!"
        }
    )
}

pub const font_weight: (&'static str, Option<&'static str>, bool) = _

font_weight

You can choose a weight for a 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:

fn app(cx: Scope) -> Element {
    render!(
        label {
            font_weight: "bold",
            "Hello, World!"
        }
    )
}

pub const font_width: (&'static str, Option<&'static str>, bool) = _

font_width

You can choose a width for a text using the font_width attribute.

Accepted values:

• ultra-condensed
• extra-condensed
• condensed
• normal (default)
• semi-expanded
• expanded
• extra-expanded
• ultra-expanded

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            font_weight: "bold",
            "Hello, World!"
        }
    )
}

pub const text_align: (&'static str, Option<&'static str>, bool) = _

text_align

You can change the alignment of the text using the text_align attribute.

Accepted values: center, end, justify, left, right, start

Example

fn app(cx: Scope) -> Element {
    render!(
        label {
            text_align: "right",
            "Hello, World!"
        }
    )
}

pub const max_lines: (&'static str, Option<&'static str>, bool) = _

max_lines

Determines the amount of lines that the text can have. It has unlimited lines by default.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            "Hello, World! \n Hello, World! \n Hello, world!" // Will show all three lines
        }
        label {
            lines_height: "2",
            "Hello, World! \n Hello, World! \n Hello, world!" // Will only show two lines
        }
    )
}

pub const rotate: (&'static str, Option<&'static str>, bool) = _

rotate

The rotate attribute let’s you rotate an element.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            rotate: "180deg",
            "Hello, World!"
        }
    )
}

Compatible elements: all except text.

pub const line_height: (&'static str, Option<&'static str>, bool) = _

line_height

Specify the height of the lines of the text.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            line_height: "3",
            "Hello, World! \n Hello, again!"
        }
    )
}

pub const letter_spacing: (&'static str, Option<&'static str>, bool) = _

letter_spacing

Specify the spacing between characters of the text.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            letter_spacing: "10",
            "Hello, World!"
        }
    )
}

pub const word_spacing: (&'static str, Option<&'static str>, bool) = _

word_spacing

Specify the spacing between words of the text.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            word_spacing: "10",
            "Hello, World!"
        }
    )
}

pub const decoration: (&'static str, Option<&'static str>, bool) = _

decoration

Specify the decoration in a text.

Accpted values:

• underline
• line-through
• overline

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            decoration: "line-through",
            "Hello, World!"
        }
    )
}

pub const decoration_style: (&'static str, Option<&'static str>, bool) = _

decoration_style

Specify the decoration’s style in a text.

Accpted values:

• solid (default)
• double
• dotted
• dashed
• wavy

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            decoration: "line-through",
            decoration_style: "dotted",
            "Hello, World!"
        }
    )
}

pub const decoration_color: (&'static str, Option<&'static str>, bool) = _

decoration_color

Specify the decoration’s color in a text.

You can learn about the syntax of this attribute in Color Syntax.

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            decoration: "line-through",
            decoration_color: "orange",
            "Hello, World!"
        }
    )
}

pub const text_overflow: (&'static str, Option<&'static str>, bool) = _

text_overflow

Determines how text is treated when it exceeds its 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)
• ellipsis

Example:

fn app(cx: Scope) -> Element {
    render!(
        label {
            max_lines: "3",
            text_overflow: "ellipsis",
            "Looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong text"
        }
    )
}

pub const focusable: (&'static str, Option<&'static str>, bool) = _

pub const margin: (&'static str, Option<&'static str>, bool) = _

margin

Specify the margin of an element. You can do so by three different ways, just like in CSS.

fn app(cx: Scope) -> Element {
    render!(
        rect {
            margin: "25" // 25 in all sides
            margin: "100 50" // 100 in top and bottom, and 50 in left and right
            margin: "5 7 3 9" 5 // in top, 7 in right, 3 in bottom and 9 in left
        }
    )
}

pub const opacity: (&'static str, Option<&'static str>, bool) = _

opacity

Specify the opacity of an element and all its desdendants.

Example:

fn app(cx: Scope) -> Element {
    render!(
        rect {
            opacity: "0.5", // 50% visible
            label {
                "I am fading!"
            }
        }
    )
}

pub const layer: (&'static str, Option<&'static str>, bool) = _

pub const role: (&'static str, Option<&'static str>, bool) = _

pub const alt: (&'static str, Option<&'static str>, bool) = _

pub const focus_id: (&'static str, Option<&'static str>, bool) = _

pub const name: (&'static str, Option<&'static str>, bool) = _