Badge: badges

Build badges with Badge. This page includes a runnable example, all props, and behavior constraints.

Complete example

Complete environment setup first. Copy this complete main.go and run go run ..

package main

import (
	"github.com/dxui-org/dxui"
	"log"
)

func main() {

	app := dxui.NewApp(dxui.AppOptions{
		Title:      "Badge",
		Width:      640,
		Height:     480,
		Background: dxui.RGBA(248, 250, 252, 255),
	})
	if err := app.Run(func() dxui.View {
		return dxui.Box(
			dxui.BoxProps{
				Gap: 16,
				Style: dxui.Style{
					Padding: dxui.Padding(24),
				},
			},
			dxui.Badge(
				dxui.BadgeProps{
					Style: dxui.Style{
						Background: dxui.TokenColor(dxui.Color.Semantic.Success),
					},
				},
				dxui.Label("Ready"),
			),
		)
	}); err != nil {

		log.Fatal(err)
	}
}

Parameters and API

func Badge(props BadgeProps, child View) View

Field	Type	Purpose, defaults, and constraints
Key	string	Stable unique identity within one parent; empty by default. Use business IDs in dynamic lists, not changing indices.
Style	Style	Local layout, paint, and text styling; zero uses intrinsic sizes and theme defaults.
Token	ComponentToken	Component theme entry; empty selects its default.
States	StateStyles	Paint patches for actual interaction states; cannot fabricate state or change layout.
Pointer	PointerBehavior	Defaults to PointerAuto; PointerNone excludes the entire subtree from pointer participation, unlike Disabled.

Behavior and limitations

Accepts one arbitrary child View and inherits text/icon color. Defaults to a compact pill. No events, focus, or retained interaction state. Notification positioning, count caps, dismissal, status variants, and animation are not built in; compose layout and Style as needed.

All components share identity, style, and pointer rules. See full declarations for referenced enums, structs, and comments. Running examples explains build verification.