M5Label

M5Label is a widget that can be used to create labels in the user interface. It can display text and can be styled with different fonts, colors, and sizes.

UiFlow2 Example

scroll label

Open the cores3_scroll_label_example.m5f2 project in UiFlow2.

This example demonstrates how to create a label that scrolls text in a circular manner.

UiFlow2 Code Block:

Example output:

None

MicroPython Example

scroll label

This example demonstrates how to create a label that scrolls text in a circular manner.

MicroPython Code Block:

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
import m5ui
import lvgl as lv


page0 = None
label0 = None


def setup():
    global page0, label0

    M5.begin()
    m5ui.init()
    page0 = m5ui.M5Screen(bg_c=0xFFFFFF)
    label0 = m5ui.M5Label(
        "It is a circularly scrolling text. ",
        x=60,
        y=110,
        text_c=0x000000,
        bg_c=0xFFFFFF,
        bg_opa=0,
        font=lv.font_montserrat_14,
        parent=page0,
    )

    page0.screen_load()
    label0.set_long_mode(lv.label.LONG_MODE.SCROLL_CIRCULAR)
    label0.set_width(150)
    label0.align_to(page0, lv.ALIGN.CENTER, 0, 0)


def loop():
    global page0, label0
    M5.update()


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            m5ui.deinit()
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

Example output:

None

API

M5Label

class m5ui.label.M5Label(*args, **kwargs)

Bases: label

Create a label object.

Parameters:

• text (str) – The text to display on the label.

• x (int) – The x position of the label.

• y (int) – The y position of the label.

• text_c (int) – The text color of the label in hexadecimal format.

• bg_c (int) – The background color of the label in hexadecimal format.

• bg_opa (int) – The background opacity of the label (0-255).

• font (lv.lv_font_t) – The font to use for the button text.

• parent (lv.obj) – The parent object to attach the button to. If not specified, the button will be attached to the default screen.

UiFlow2 Code Block:

None

MicroPython Code Block:

from m5ui import M5Label
import lvgl as lv

m5ui.init()
label_0 = M5Label(text="Hello, World!", x=10, y=10, text_c=0x212121, bg_c=0xFFFFFF, bg_opa=0, font=lv.font_montserrat_14, parent=page0)

set_flag(flag, value)

Set a flag on the object. If value is True, the flag is added; if False, the flag is removed.

Parameters:

• flag (int) – The flag to set.

• value (bool) – If True, the flag is added; if False, the flag is removed.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_flag(lv.obj.FLAG.HIDDEN, True)

toggle_flag(flag)

Toggle a flag on the object. If the flag is set, it is removed; if not set, it is added.

Parameters:

flag (int) – The flag to toggle.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.toggle_flag(lv.obj.FLAG.HIDDEN)

set_state(state, value)

Set the state of the label. If value is True, the state is set; if False, the state is unset.

Parameters:

• state (int) – The state to set.

• value (bool) – If True, the state is set; if False, the state is unset.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_state(lv.STATE.PRESSED, True)

toggle_state(state)

Toggle the state of the label. If the state is set, it is unset; if not set, it is set.

Parameters:

state (int) – The state to toggle.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.toggle_state(lv.STATE.PRESSED)

set_style_text_font(font, part)

Set the font of the label text.

Parameters:

• font (lv.lv_font_t) – The font to set.

• part (int) – The part of the object to apply the style to (e.g., lv.PART.MAIN).

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_style_text_font(lv.font_montserrat_14, lv.PART.MAIN | lv.STATE.DEFAULT)

set_text_color(color, opa, part)

Set the color of the text.

Parameters:

• color (int) – The color to set.

• opa (int) – The opacity of the color.

• part (int) – The part of the object to apply the style to (e.g., lv.PART.MAIN).

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_text_color(lv.color_hex(0x000000), 255, lv.PART.MAIN | lv.STATE.DEFAULT)

set_bg_color(color, opa, part)

Set the background color of the label.

Parameters:

• color (int) – The color to set.

• opa (int) – The opacity of the color.

• part (int) – The part of the object to apply the style to (e.g., lv.PART.MAIN).

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_bg_color(lv.color_hex(0x000000), 255, lv.PART.MAIN | lv.STATE.DEFAULT)

set_pos(x, y)

Set the position of the label.

Parameters:

• x (int) – The x-coordinate of the label.

• y (int) – The y-coordinate of the label.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_pos(100, 100)

set_x(x)

Set the x-coordinate of the label.

Parameters:

x (int) – The x-coordinate of the label.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_x(100)

set_y(y)

Set the y-coordinate of the label.

Parameters:

y (int) – The y-coordinate of the label.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_y(100)

set_size(width, height)

Set the size of the label.

Parameters:

• width (int) – The width of the label.

• height (int) – The height of the label.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_size(100, 50)

set_width(width)

Set the width of the label.

Parameters:

width (int) – The width of the label.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_width(100)

align_to(obj, align, x, y)

Align the label to another object.

Parameters:

• obj (lv.obj) – The object to align to.

• align (int) – The alignment type.

• x (int) – The x-offset from the aligned object.

• y (int) – The y-offset from the aligned object.

Returns:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.align_to(page_0, lv.ALIGN.CENTER, 0, 0)

set_shadow(color, opa, align, offset_x, offset_y)

Set a shadow for the label.

Parameters:

• color (int) – The color of the shadow in hexadecimal format or an integer.

• opa (int) – The opacity of the shadow (0-255).

• align (int) – The alignment of the shadow relative to the label.

• offset_x (int) – The horizontal offset of the shadow.

• offset_y (int) – The vertical offset of the shadow.

Returns:

None

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

label_0.set_shadow(color=0x000000, opa=128, align=lv.ALIGN.BOTTOM_RIGHT, offset_x=5, offset_y=5)

unset_shadow()

Remove the shadow from the label.

UiFlow2 Code Block:

MicroPython Code Block:

label_0.unset_shadow()

Return type:

None