Skip to main content

Icon

Renders a single text glyph (such as a Unicode symbol or emoji) with icon-friendly defaults.

Drift does not bundle an icon font. For icons, use SvgIcon to render SVG files from your own assets, or use Image for PNG/raster icons.

Basic Usage​

widgets.Icon{
    Glyph: "★",
    Size:  24,
    Color: colors.Primary,
}

For theme-styled icons with sensible defaults (size 24, OnSurface color):

theme.IconOf(ctx, "✓")

Properties​

PropertyTypeDescription
GlyphstringThe text glyph to render
Sizefloat64Font size in pixels (zero means not rendered)
Colorgraphics.ColorGlyph color (zero means transparent)
Weightgraphics.FontWeightFont weight (optional)

Common Patterns​

Glyph Icon in a Row​

widgets.Row{
    CrossAxisAlignment: widgets.CrossAxisAlignmentCenter,
    MainAxisSize:       widgets.MainAxisSizeMin,
    Children: []core.Widget{
        widgets.Icon{Glyph: "✉", Size: 20, Color: colors.OnSurfaceVariant},
        widgets.HSpace(8),
        widgets.Text{Content: "user@example.com", Style: textTheme.BodyMedium},
    },
}

SVG Icon from an Asset​

For real icon assets, use SvgIcon with SVG files bundled in your app:

var svgCache = svg.NewIconCache()

func loadIcon(name string) *svg.Icon {
    icon, _ := svgCache.Get(name, func() (*svg.Icon, error) {
        f, err := assetFS.Open("assets/" + name)
        if err != nil {
            return nil, err
        }
        defer f.Close()
        return svg.Load(f)
    })
    return icon
}

// Then use it in your widget tree:
widgets.SvgIcon{
    Source: loadIcon("settings.svg"),
    Size:   24,
    TintColor: colors.Primary,
}