Skip to content

Input Field Types

Julian Waller edited this page Sep 29, 2022 · 3 revisions

Companion has a standardised set of input fields usable across actions, feedbacks and module config.
There are some small differences in what is available where, documented here.

One quick definition, we shall be using 'input group' to mean the group of input fields for the current action/feedback/module-config.

All the types are well defined in the api documentation, which shall be linked to below. Unfortonately it is only possible to view the documentation for the latest version of @companion-module/base, but we shall do our best to clarify when things were added inside the documentation.

There are some common properties across every type of input

It is possible that there are some new field types not linked to in the list above. You can discover these in the 'Heirarchy' section of this page.

Clone this wiki locally