Modifiers¶

Modifiers are a mechanism for adding functionality to Widgets. Use them when you want to add decorations like background color or corner radius to a Widget, or when you want to add interaction like clickability.

Basic Usage¶

You can add functionality to a Widget by passing a Modifier to the modifier() method that all Widgets have. If you want to attach multiple Modifiers, you can chain them with the | operator.

import nuiitivet.material as nv

# Add background color with background
text1 = nv.Text("Hello").modifier(nv.background("#FF5722"))

# Add corner radius with corner_radius
text2 = nv.Text("Rounded Box").modifier(nv.background("#2196F3") | nv.corner_radius(8))

Modifier Basic Usage

It's similar to Modifiers in SwiftUI or Jetpack Compose, but Nuiitivet does not provide layout-related functions in Modifiers. Layout should be handled by Widgets and parameters alone; allowing Modifiers to handle layout would make the code complex.

Types of Modifiers¶

Modifiers are categorized into the following types:

Decoration: Add visual decorations like background, border, corner radius, clip, and shadow.
Interaction: Add interaction capabilities like clickable, hoverable, focusable, file drops, and keyboard shortcuts.
Pointer Participation: Control which overlapping widget catches a click — defer_pointer, block_pointer, absorb_pointer, and passthrough_pointer.
Transform: Apply paint-only transformations like opacity, rotate, scale, and translate.
Popup: Attach anchored transient overlays like menus, dropdowns, and tooltips.
Lifecycle: Run callbacks when a widget is mounted or unmounted, including async tasks.
Others: Other functionalities like on_size_changed, will_pop, and stick.