Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

settings

package

Go to main page

Versions in this module

v0

v0.5.2

Mar 28, 2026

v0.5.1

Mar 28, 2026

v0.5.0

Mar 20, 2026

v0.4.1

Mar 18, 2026

Changes in this version

type Setting

+ DevOnly bool

v0.4.0

Mar 16, 2026

v0.3.1

Mar 14, 2026

v0.3.0

Mar 12, 2026

Changes in this version

+ type CategoryChangeFunc func(values map[string]any)

type Provider

+ RegisterChangeHandler func(categoryID string, fn CategoryChangeFunc)

v0.2.1

Mar 10, 2026

v0.2.0

Mar 6, 2026

Changes in this version

type SettingType

+ const MultiSelect

+ const Select

v0.1.2

Feb 26, 2026

v0.1.1

Feb 25, 2026

v0.1.0

Feb 25, 2026

Changes in this version

+ const BaseDir

+ const StoreFile

+ var AllSettingTypes = []struct{ ... }

+ var ErrInvalidSettingID = errors.New("invalid setting ID")

+ var ErrSettingCategoryNotFound = errors.New("setting category not found")

+ var ErrSettingNotFound = errors.New("setting not found")

+ var ErrSettingTypeMismatch = errors.New("setting type mismatch")

+ func GetStore(pluginID string) (*os.File, error)

+ func GetStorePath(pluginID string) (string, error)

+ func RemoveStore(pluginID string) error

+ type Category struct

+ Description string

+ ID string

+ Icon string

+ Label string

+ Settings map[string]Setting

+ type Provider interface

+ GetBool func(id string) (bool, error)

+ GetCategories func() []Category

+ GetCategory func(id string) (Category, error)

+ GetCategoryValues func(id string) (map[string]interface{}, error)

+ GetFloat func(id string) (float64, error)

+ GetFloatSlice func(id string) ([]float64, error)

+ GetInt func(id string) (int, error)

+ GetIntSlice func(id string) ([]int, error)

+ GetSetting func(id string) (Setting, error)

+ GetSettingValue func(id string) (any, error)

+ GetString func(id string) (string, error)

+ GetStringSlice func(id string) ([]string, error)

+ Initialize func(ctx context.Context, categories ...Category) error

+ ListSettings func() Store

+ LoadSettings func() error

+ RegisterSetting func(categoryID string, setting Setting) error

+ RegisterSettings func(categoryID string, settings ...Setting) error

+ ResetSetting func(id string) error

+ SaveSettings func() error

+ SetSetting func(id string, value any) error

+ SetSettings func(settings map[string]any) error

+ Values func() map[string]any

+ func NewProvider(opts ProviderOpts) Provider

+ type ProviderOpts struct

+ Logger *zap.SugaredLogger

+ PluginID string

+ PluginSettings []Category

+ type Setting struct

+ Default interface{}

+ Description string

+ FileSelection *SettingFileSelection

+ ID string

+ Label string

+ Options []SettingOption

+ Sensitive bool

+ Type SettingType

+ Validator func(interface{}) error

+ Value interface{}

+ func (s *Setting) GetValue() interface{}

+ func (s *Setting) ResetValue()

+ func (s *Setting) SetValue(value interface{}) error

+ func (s *Setting) Validate(value interface{}) error

+ type SettingFileSelection struct

+ AllowFolders bool

+ DefaultPath string

+ Enabled bool

+ Extensions []string

+ Multiple bool

+ Relative bool

+ type SettingOption struct

+ Description string

+ Label string

+ Value interface{}

+ type SettingType string

+ const Color

+ const DateTime

+ const Float

+ const Integer

+ const Password

+ const Text

+ const Toggle

+ type Store map[string]Category