Skip to content

Commit

Permalink
plugin: Document ConfigOption's Help field
Browse files Browse the repository at this point in the history
  • Loading branch information
oxzi committed Jan 12, 2024
1 parent 4e5716e commit a840808
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion pkg/plugin/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,13 @@ type ConfigOption struct {
// An "en_US" locale must be given as a fallback
Label map[string]string `json:"label"`

// Element title: When the user moves the mouse pointer over an element, a tooltip is displayed with a given message.
// Element description map. Locale in the standard format (language_REGION) as key and corresponding label as value.
// Locale is assumed to be UTF-8 encoded (Without the suffix in the locale)
//
// When the user moves the mouse pointer over an element in the web UI, a tooltip is displayed with a given message.
//
// e.g. {"en_US": "HTTP request method for the request.", "de_DE": "HTTP-Methode für die Anfrage."}
// An "en_US" locale must be given as a fallback
Help map[string]string `json:"help,omitempty"`

// Element default: bool for checkbox default value, string for other elements (used as placeholder)
Expand Down

0 comments on commit a840808

Please sign in to comment.