GroupItem

GroupItem — labelled box / logical AT container.

Visually a labelled rectangle with optional fill, stroke, and inline label. Without any chrome it's a logical-only container that announces itself to AT but draws nothing — the lightweight analogue of an A11yGroup.

When to use

Use GroupItem when you need to:

Draw a visible boundary box around a cluster of related items (e.g. a lane in a Kanban board, an "Act 1" region on a corkboard).
Provide a named AT group that screen readers announce without any visible chrome — call GroupItem::label but omit fill and stroke, leaving is_visual() false.

Example

use teksilo_scene::{Scene, GroupItem};
use teksilo_canvas::{Point, Rect};
use teksilo_tokens::Color;
use teksilo_i18n::lit;

let mut scene = Scene::new();
// A visible "Act 1" box with a rounded border.
let group = GroupItem::new(Rect::new(0.0, 0.0, 400.0, 600.0))
    .label(lit!("Act 1"))
    .show_label(true)
    .stroke(Color::new(0.6, 0.6, 0.6, 1.0), 1.5)
    .corner_radius(8.0);
let _id = scene.add_item(group, Point::new(20.0, 20.0));

Builder methods at a glance

label, show_label, label_inset, label_color, fill, stroke, stroke_cosmetic, stroke_styled, corner_radius, is_visual

API reference

📖 Full rustdoc API for this module

`pub struct GroupItem`

A group container with optional fill / stroke / inline label, in local item coordinates.

Visually, GroupItem renders a labelled box around its members. Logically, it's the AT-grouping primitive: with no chrome and a label set, it announces itself to AT but draws nothing.

#![allow(unused)]
fn main() {
pub struct GroupItem { /* fields */ }
}

Methods

`pub fn new(local_bounds: Rect) -> Self`

A group covering local_bounds in local coordinates. No chrome by default — call fill / stroke / show_label to give it visible outline / background / inline label.

`pub fn label(mut self, label: impl Into<LocalizedString>) -> Self`

Human-readable label, used as the default AT group name and (when show_label is enabled) rendered inline at top-leading.

`pub fn show_label(mut self, show: bool) -> Self`

Render the label inline at paint time.

`pub fn label_inset(mut self, dx: f32, dy: f32) -> Self`

Override the inset of the inline label from the local origin.

`pub fn label_color(mut self, color: impl Into<ColorProp>) -> Self`

Override the inline label colour. Defaults to the stroke colour if set, else Color::BLACK. Accepts a plain Color, a theme role, or a reactive signal.

`pub fn fill(mut self, color: impl Into<ColorProp>) -> Self`

Background fill colour. Accepts a plain Color, a theme role, a Signal<Color>, or a Signal<Role> — resolved against the active theme at paint time.

`pub fn stroke(mut self, color: impl Into<ColorProp>, width: f32) -> Self`

Border stroke (colour + scene-coord pixel width) — scales with zoom.

`pub fn stroke_cosmetic(mut self, color: impl Into<ColorProp>, width: f32) -> Self`

Cosmetic border stroke: holds a constant device-pixel width at any zoom. With corner_radius > 0 the rounded outline goes through the SDF cosmetic path; otherwise stroke_rect emits four CosmeticLine edges (one per side), which are hard-edged and crisp at any zoom.

Teksilo Documentation