Surface API Changelog
This section describes the changes made in each new release of @companion-surface/base (the
surface module API), and which version of Companion first supports these changes. Click on the
links to read more about each topic.
Version support
Each Companion release bundles one version of the surface API. A module built against a newer
version of @companion-surface/base than the Companion it is loaded into will not work, so pick
the version matching the oldest Companion you want to support.
@companion-surface/base | Companion |
|---|---|
| v1.3 | v4.3+ |
| v1.4 | v5.1+ |
Before v1.4
Surface modules were introduced in Companion 4.3, which shipped @companion-surface/base v1.3 as
the first version available to module developers — so there is no changelog for anything earlier.
Everything described in the surface development docs is available in v1.3 unless a
changelog page says otherwise.