Embedded Lucide

The fastest path to a working setup: install the core module and the Lucide submodule, write three lines of Go, and start rendering icons.

What it does

The lucide submodule provides the Lucide icon set (~1,500 icons) embedded directly in the Go binary via go:embed. No file downloads, no network calls, no external dependencies beyond the core module.

When to use it

Reach for the embedded Lucide set as the default icon source for projects that need a general-purpose icon set with zero runtime setup.

For custom icon sets on disk, see Directory Provider. For other Iconify-format JSON sets, see JSON Collection Provider. For on-demand access to any Iconify-hosted set, see Iconify Provider.

Setup

Quick start with Default()

1
import (
2
    swarmicons "github.com/frostybee/go-swarm-icons"
3
    "github.com/frostybee/go-swarm-icons/lucide"
4
)
5
6
manager := swarmicons.Default("lucide", lucide.Provider())

This registers the Lucide set under the "lucide" prefix and sets it as the default prefix. Bare icon names (without a colon) resolve against it:

1
icon, err := manager.Get("home")       // resolves as "lucide:home"
2
icon, err  = manager.Get("lucide:star") // explicit prefix

Config builder

1
import (
2
    swarmicons "github.com/frostybee/go-swarm-icons"
3
    "github.com/frostybee/go-swarm-icons/lucide"
4
)
5
6
manager, err := swarmicons.NewConfig().
7
    AddProvider("lucide", lucide.Provider()).
8
    DefaultPrefix("lucide").
9
    DefaultAttributes(map[string]string{
10
        "stroke":       "currentColor",
11
        "stroke-width": "2",
12
        "fill":         "none",
13
    }).
14
    Build()

Options & behavior

Return type

lucide.Provider() returns *swarmicons.JsonCollectionProvider, not the Provider interface directly. It satisfies the Provider interface and can be passed anywhere a Provider is expected.

Embedded data

The submodule uses go:embed lucide.json to bundle the Iconify JSON collection. The embedded file is approximately 800 KB and adds that amount to the compiled binary size.

Inherited behavior

Because lucide.Provider() returns a JsonCollectionProvider, it inherits all of that provider's behavior:

• Lazy parsing: the embedded JSON is parsed on the first call to Get(), Has(), or All().
• Alias resolution: Lucide aliases (if any exist in the JSON) resolve recursively up to 10 levels.
• Caching: resolved icons are cached in a thread-safe in-memory map.
• Root-level defaults: the embedded JSON specifies width: 24 and height: 24 as defaults.

Icon count

All() returns more than 1,000 icon names. The exact count depends on the version of the embedded Lucide JSON.

Installation

The Lucide submodule is a separate Go module. Install it alongside the core module:

go get github.com/frostybee/go-swarm-icons@latest
go get github.com/frostybee/go-swarm-icons/lucide@latest

Examples

Render an icon

1
import (
2
    "fmt"
3
4
    swarmicons "github.com/frostybee/go-swarm-icons"
5
    "github.com/frostybee/go-swarm-icons/lucide"
6
)
7
8
func main() {
9
    manager := swarmicons.Default("lucide", lucide.Provider())
10
11
    icon, err := manager.Get("rocket")
12
    if err != nil {
13
        panic(err)
14
    }
15
16
    fmt.Println(icon.Size(24).Class("text-primary").ToHTML())
17
}

Alongside other providers

1
import (
2
    "fmt"
3
    "log"
4
5
    swarmicons "github.com/frostybee/go-swarm-icons"
6
    "github.com/frostybee/go-swarm-icons/lucide"
7
)
8
9
func main() {
10
    manager, err := swarmicons.NewConfig().
11
        AddProvider("lucide", lucide.Provider()).
12
        AddIconifySet("mdi").
13
        AddDirectory("custom", "./icons").
14
        DefaultPrefix("lucide").
15
        Build()
16
    if err != nil {
17
        log.Fatal(err)
18
    }
19
20
    // Lucide icon (default prefix)
21
    home, _ := manager.Get("home")
22
    fmt.Println(home.ToHTML())
23
24
    // Material Design icon (explicit prefix)
25
    mdiHome, _ := manager.Get("mdi:home")
26
    fmt.Println(mdiHome.ToHTML())
27
28
    // Custom icon from disk
29
    logo, _ := manager.Get("custom:logo")
30
    fmt.Println(logo.ToHTML())
31
}

Choosing a provider

See also

• Providers API reference: full JsonCollectionProvider API (which lucide.Provider() returns)
• JSON Collection Provider: load other Iconify sets beyond Lucide
• Quick Start: the fastest path using this submodule