Type "color"

If your function implementation needs to meet some custom requirements and you want to choose the colors of visual elements like text or shapes to display it in your UI, you can use environment variables of type color in your implementation. Then our platform will ask consumers to select from a picker a color value during installation.

The type color variables allow consumers of a function to select a specific color, either by using the visual color picker interface or by entering the color into the text field in #rrggbb hexadecimal format. It is displayed in the installation UI form as a color input element (see image below).

Example of a type "color" environment variable definition

"env": [
    {
        "name": "BRAND_COLOR",
        "type": "color",
        "description": "Main color for UI",
        "required": false,
        "default": "#01b6f5"
    }
]
‌

Example of how to consume the value of the environment variable within the function implementation

const myFunction = () => {
    const brandColor = process.env.BRAND_COLOR
    ...
};

module.exports = myFunction;

Properties of the type

property	type	required	default	description
name	string	yes	-	The name of the environment variable. This should be unique for each variable.
description	string	no	-	The description of the environment variable.
default	string	no	-	The default value for the variable.
required	bool	no	false	Specifies that a variable must be filled out before submitting.