Config Builder

The fluent builder for constructing an IconManager with multiple providers, attribute defaults, aliases, and fallbacks.

Overview

Config is a fluent builder for constructing an IconManager. Chain configuration methods and call Build to produce a fully configured manager.

For guides on the features configured through the builder, see Aliases & Fallbacks and Attribute Management.

Types

Config

1
type Config struct {
2
    // unexported fields
3
}

Functions

NewConfig

1
func NewConfig() *Config

Creates an empty Config ready for method chaining.

Methods

All methods return *Config for chaining unless noted otherwise.

Provider registration

AddProvider

1
func (c *Config) AddProvider(prefix string, provider Provider) *Config

Registers a pre-built provider under prefix. Immediate: the provider is used as-is during Build.

AddDirectory

1
func (c *Config) AddDirectory(prefix, dir string) *Config

Registers a DirectoryProvider for dir under prefix. Deferred: the provider is constructed during Build. Returns an error from Build if the directory is invalid.

AddJsonCollection

1
func (c *Config) AddJsonCollection(prefix, path string) *Config

Registers a JsonCollectionProvider for the JSON file at path under prefix. Deferred: the file is read during Build. Returns an error from Build if the file cannot be read.

AddIconifySet

1
func (c *Config) AddIconifySet(prefix string) *Config

Registers an IconifyProvider under prefix. Deferred: the provider is constructed during Build.

AddHybridSet

1
func (c *Config) AddHybridSet(prefix, dir string) *Config

Registers a ChainProvider combining a DirectoryProvider (for dir) and an IconifyProvider, both under prefix. The directory is checked first. Deferred: both providers are constructed during Build. Returns an error from Build if the directory is invalid.

DiscoverJsonSets

1
func (c *Config) DiscoverJsonSets(dir string) *Config

Scans dir for *.json files and registers each as a JsonCollectionProvider using the filename (without extension) as the prefix. Files are sorted alphabetically. Silently skips the call if the glob fails. Deferred.

Attribute configuration

DefaultPrefix

1
func (c *Config) DefaultPrefix(prefix string) *Config

Sets the prefix used when Get receives a bare name with no colon.

DefaultAttributes

1
func (c *Config) DefaultAttributes(attrs map[string]string) *Config

Sets attributes applied globally to every icon at layer 2 (after the icon's own attributes). Calling this method multiple times is additive: later calls merge into earlier ones.

PrefixAttributes

1
func (c *Config) PrefixAttributes(prefix string, attrs map[string]string) *Config

Sets attributes applied to all icons from prefix at layer 3. Calling multiple times for the same prefix is additive.

PrefixSuffix

1
func (c *Config) PrefixSuffix(prefix, suffix string, attrs map[string]string) *Config

Sets attributes applied at layer 4 to icons under prefix whose name ends with "-{suffix}". Pass an empty suffix as a catch-all for icons under that prefix that match no other suffix.

Resolution configuration

Alias

1
func (c *Config) Alias(alias, target string) *Config

Maps alias to target. When Get(alias) is called, the target name is substituted before resolution.

FallbackIcon

1
func (c *Config) FallbackIcon(name string) *Config

Sets the global fallback icon name returned when a requested icon is not found.

FallbackIconForPrefix

1
func (c *Config) FallbackIconForPrefix(prefix, name string) *Config

Sets a fallback icon used only when an icon from prefix is not found. Checked before the global fallback.

IgnoreNotFound

1
func (c *Config) IgnoreNotFound() *Config

Configures the built manager to return an empty *Icon (no error) instead of ErrIconNotFound or ErrProviderNotFound.

Terminal

Build

1
func (c *Config) Build() (*IconManager, error)

Constructs and returns an IconManager from the accumulated configuration. Initializes all deferred providers and returns an error if any provider fails to load. The IconRenderer is built from the configured default, prefix, and suffix attributes.

Deferred vs. immediate

Example

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
    AddDirectory("custom", "./icons").
9
    AddIconifySet("mdi").
10
    DefaultPrefix("lucide").
11
    DefaultAttributes(map[string]string{
12
        "fill":         "none",
13
        "stroke":       "currentColor",
14
        "stroke-width": "2",
15
    }).
16
    PrefixAttributes("mdi", map[string]string{
17
        "fill": "currentColor",
18
    }).
19
    Alias("check", "lucide:check-circle").
20
    FallbackIcon("lucide:help-circle").
21
    IgnoreNotFound().
22
    Build()

See also

• Providers API reference: constructor signatures and methods for each provider type
• Installation: which modules to install for each provider type