settings

package

v0.3.5 Latest Latest Go to latest Published: Apr 16, 2026 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/anthonybaldwin/UsageButtons

Links

Open Source Insights

Documentation ¶

Overview ¶

Package settings manages global and per-key plugin settings.

Index ¶

Constants
Variables
func InvertFillEnabled() bool
func ResolveRefreshMs(ks KeySettings) int64
func Set(gs GlobalSettings)
func ShowGlyphsEnabled() bool
func SkipUpdateCheckEnabled() bool
type GlobalSettings
- func Get() GlobalSettings
type KeySettings
type TextSize
- func DefaultSubvalueSz() TextSize
- func DefaultValueSz() TextSize

Constants ¶

View Source

const DefaultRefreshMinutes = 15

Variables ¶

View Source

var RefreshPresets = []int{5, 10, 15, 30, 60}

RefreshPresets are the allowed refresh intervals in minutes.

Functions ¶

func InvertFillEnabled ¶

func InvertFillEnabled() bool

InvertFillEnabled returns the global invert-fill toggle.

func ResolveRefreshMs ¶

func ResolveRefreshMs(ks KeySettings) int64

ResolveRefreshMs returns the effective refresh interval in ms for a key.

func Set ¶

func Set(gs GlobalSettings)

Set replaces the global settings, normalising values.

func ShowGlyphsEnabled ¶

func ShowGlyphsEnabled() bool

ShowGlyphsEnabled returns the global show-glyphs toggle.

func SkipUpdateCheckEnabled ¶

func SkipUpdateCheckEnabled() bool

SkipUpdateCheckEnabled returns the skip-update-check toggle.

Types ¶

type GlobalSettings ¶

type GlobalSettings struct {
	DefaultRefreshMinutes *int     `json:"defaultRefreshMinutes,omitempty"`
	DefaultValueSize      TextSize `json:"defaultValueSize,omitempty"`
	DefaultSubvalueSize   TextSize `json:"defaultSubvalueSize,omitempty"`
	InvertFill            bool     `json:"invertFill,omitempty"`
	ShowGlyphs            *bool    `json:"showGlyphs,omitempty"`
	SkipUpdateCheck       bool     `json:"skipUpdateCheck,omitempty"`
}

GlobalSettings are shared across every key and persisted by Stream Deck (survive plugin rebuilds, ride with user profiles).

func Get ¶

func Get() GlobalSettings

Get returns the current global settings.

type KeySettings ¶

type KeySettings struct {
	// Provider is now derived from action UUID; this field is
	// kept for backwards compat but ignored.
	ProviderID      string   `json:"providerId,omitempty"`
	MetricID        string   `json:"metricId,omitempty"`
	RefreshMinutes  *int     `json:"refreshMinutes,omitempty"`
	WarnBelow       *float64 `json:"warnBelow,omitempty"`
	CriticalBelow   *float64 `json:"criticalBelow,omitempty"`
	WarnColor       string   `json:"warnColor,omitempty"`
	CriticalColor   string   `json:"criticalColor,omitempty"`
	LabelOverride   string   `json:"labelOverride,omitempty"`
	HideLabel       bool     `json:"hideLabel,omitempty"`
	CaptionOverride string   `json:"captionOverride,omitempty"`
	FillColor       string   `json:"fillColor,omitempty"`
	BgColor         string   `json:"bgColor,omitempty"`
	TextColor       string   `json:"textColor,omitempty"`
	FillDirection   string   `json:"fillDirection,omitempty"`
	ValueSize       TextSize `json:"valueSize,omitempty"`
	SubvalueSize    TextSize `json:"subvalueSize,omitempty"`
	ShowBorder      *bool    `json:"showBorder,omitempty"`
	ShowGlyph       *bool    `json:"showGlyph,omitempty"`
	ShowResetTimer  *bool    `json:"showResetTimer,omitempty"`
	ShowRawCounts   *bool    `json:"showRawCounts,omitempty"`
}

KeySettings are per-button settings stored by Stream Deck.

type TextSize ¶

type TextSize string

const (
	TextSmall  TextSize = "small"
	TextMedium TextSize = "medium"
	TextLarge  TextSize = "large"
)

func DefaultSubvalueSz ¶

func DefaultSubvalueSz() TextSize

DefaultSubvalueSz returns the global default subvalue text size.

func DefaultValueSz ¶

func DefaultValueSz() TextSize

DefaultValueSz returns the global default value text size.

Source Files ¶

View all Source files

settings.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL