icons.go

// Copyright (c) 2023, The Goki Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// Package icons provides Go constant names for Material Design Symbols as SVG files.
package icons

import (
	"embed"
	"io/fs"
	"strings"

	_ "github.com/iancoleman/strcase" // needed so that it gets included in the mod (the generator uses it)
	"goki.dev/glop/dirs"
	"goki.dev/grr"
)

//go:generate go run gen.go

// Icons contains all of the embedded svg icons. It is initialized
// to contain of the default icons located in the svg directory
// (https://github.com/goki/icons/tree/main/svg), but it can be extended
// by any packages by using a merged fs package. All icons should be stored
// in the root directory of the fs, which can be accomplished using [fs.Sub]
// if you have icons in a subdirectory.
var Icons fs.FS = grr.Log1(fs.Sub(defaults, "svg"))

// defaults contains the default icons.
//
//go:embed svg/*.svg
var defaults embed.FS

const (
	// None is an icon that indicates to not use an icon.
	// It completely prevents the rendering of an icon,
	// whereas [Blank] renders a blank icon.
	None Icon = "none"

	// Blank is a blank icon that can be used as a
	// placeholder when no other icon is appropriate.
	// It still renders an icon, just a blank one,
	// whereas [None] indicates to not render one at all.
	Blank Icon = "blank"
)

// Icon contains the name of an icon
type Icon string

func (i Icon) String() string {
	return string(i)
}

// Fill returns the icon as a filled icon.
// It returns the icon unchanged if it is already filled.
func (i Icon) Fill() Icon {
	if i.IsFilled() {
		return i
	}
	return i + "-fill"
}

// Unfill returns the icon as an unfilled icon.
// It returns the icon unchanged if it is already unfilled.
// Icons are unfilled by default, so you only
// need to call this to reverse a prior [Icon.Fill] call
func (i Icon) Unfill() Icon {
	return Icon(strings.TrimSuffix(string(i), "-fill"))
}

// IsFilled returns whether the icon
// is a filled icon.
func (i Icon) IsFilled() bool {
	return strings.HasSuffix(string(i), "-fill")
}

// IsNil returns whether the icon name is "" or
// [None], which indicates not to use an icon.
func (i Icon) IsNil() bool {
	return i == "" || i == None
}

// Filename returns the filename of the icon in [Icons]
func (i Icon) Filename() string {
	return string(i) + ".svg"
}

// IsValid returns whether the icon name corresponds to
// a valid existing icon.
func (i Icon) IsValid() bool {
	if i.IsNil() {
		return false
	}
	ex, _ := dirs.FileExistsFS(Icons, i.Filename())
	return ex
}

// AllIcons is a list of all icons
var AllIcons []Icon

// All returns a list of all the Icons (excluding "fill" versions)
func All() []Icon {
	if AllIcons != nil {
		return AllIcons
	}
	files, err := fs.ReadDir(Icons, ".")
	if err != nil {
		return nil
	}
	ics := make([]Icon, 0, len(files)/2) // no fill
	for _, fi := range files {
		nm := fi.Name()
		if strings.HasSuffix(nm, "-fill.svg") {
			continue
		}
		ic := Icon(strings.TrimSuffix(fi.Name(), ".svg"))
		ics = append(ics, ic)
	}
	AllIcons = ics
	return AllIcons
}