[Feat] Preset text fields #2843
Labels
area/gui
GUI / Webapp related
Enhancement
New feature or request
Needs UX/design work
This needs thought on the user experience or ui design in order to progress
Is this a feature relevant to companion itself, and not a module?
Is there an existing issue for this?
Describe the feature
Currently presets are defined by module developers as an array of
CompanionButtonPresetDefinition
's. What I'm proposing is for there to be an alternative structure to allow for more functionality while still being backwards compatible by allowing the existing structure to work without modification.As an example of the sort of thing I had in mind
In this example, there would be a line of text that can be rendered by the web-ui above the preset categories. Additionally, inside the preset categories there would either by the
button
type, which would be displayed as they currently are, or a newstatic-text
type which could cause the web-ui to create a line break and some text.On Companions side there would need to be a check when a modules instance sends the presets as to if they are an array of presets, or an object with the categories property for example, as this would allow for full backwards compatibility. Implementing this feature request could also be done in stages too, where initially the structure remains unchanged but a 'static-text' type is created, as there is already a 'type' field but it's limited to 'button', and then at some point in time later adjust the structure to allow for text on the categories page.
Usecases
The use case for this is that much like config options, it can be be a better user experience to have some short simple instructions on how the presets are intended to be used, maybe including a link to some documentation on github, mentioning what custom-variables may need to be created/used, and for future upgrades to the preset system this could also be utilized for instructions on things like mass copying of presets to a page should that ever be thing.
The text was updated successfully, but these errors were encountered: