Theme Properties
Themes have properties that constitute metadata or influence the way they are rendered. The theme developer can set some of these in a properties file named theme.properties at the root level of their theme. The file must be encoded in UTF-8.
The following table documents the available properties, their default value, and their effect.
| Property Key | Description | Default Value |
|---|---|---|
theme.plugin.key | The key of the plug-in when the theme is downloaded as a JAR file. | A slugified version of the theme name. |
theme.plugin.name | The name of the plug-in when the theme is downloaded as a JAR file. | <theme-name> - Scroll Viewport Theme |
theme.plugin.version | The version of the plug-in when the theme is downloaded as a JAR file. | 1.0 |
theme.plugin.module.key | The module key of the theme in the plug-in when the theme is downloaded as a JAR file. | Same as the plug-in key. |
theme.description | A textual description of the theme. | |
theme.enableViewportControl | Controls whether the Viewport Control is enabled in the theme. | true |
Example
theme.properties
TEXT
theme.plugin.key=com.example.my-theme-plugin
theme.plugin.name=My Viewport Theme Plugin
theme.plugin.version=1.0
theme.plugin.module.key=my-theme
theme.description=This is my first Viewport Theme.
theme.enableViewportControl=true