Parameters Dashboard
The Parameters Dashboard is a simple yet highly optimized app designed to empower developers to effortlessly create parameter dashboards. This dashboard facilitates the retrieval of parameter values in both the frontend and backend of the application, offering performance optimization and caching.
The inclusion of a "development mode" feature enhances the development process, allowing the retrieval of secondary or mocked values instead of actual parameter values while testing or debugging.
Site administrators can seamlessly update their site parameters, ensuring efficient and dynamic management of their website behaviour.
Features
The Parameters Dashboard is a simple yet highly optimized app designed to empower developers to effortlessly create parameter dashboards using a simple file. This dashboard facilitates the retrieval of parameter values in both the frontend and backend of the application, offering performance optimization and caching.
The inclusion of a "development mode" feature enhances the testing and development process, allowing the retrieval of secondary or mocked values instead of actual parameter values while testing or debugging.
Site administrators can seamlessly update their site parameters, ensuring efficient and dynamic management of their website behaviour.
Installation
You can install the app via the site selector or via the Wix App Market.
The app is free to install but with limited functionalities. Subscribe to Unlimited to unlock all features.
Settings
Parameters
Parameters are managed via the collection @code-enhancement-studio/parameter-manager/parameters in Wix CMS.
Parameters have the following properties:
-
Key: the key to retrieve the parameter in your code. It should be unique.
-
Label: The name displayed in the dashboard.
-
Description: a short description of parameter intent to inform site administrators.
-
Type: expected value's type. Currently, the following types are supported: string, number, email, and boolean.
-
IsRequired: if true, the prod value cannot be empty.
-
Value: an object with properties prod and dev. Cannot be edited via the CMS and can only be changed via the dashboard.
Do not store sensitive information in parameters. You should use Wix-secrets API instead.
Dev Mode
devMode is enabled or disabled via the app's config.json in the editor. This allows developers to change site behaviour in preview or test versions without impacting the live website.
When isDevMode = true, getParameterValues returns dev values instead of prod values if available.
Usage
Changing Values
Using the app admin dashboard you can change parameters values
Retrieving Values
Using the method getParameterValues(...keys)from @code-enhancement-studio/parameter-manager you can retrieve parameter values for the current mode as an object.
The method getParameterValues(...keys) from @code-enhancement-studio/parameter-manager-backend must be used when working within backend files.
Caching
Both frontend & backend methods rely on in-memory caching to improve performances. This means that your modification might be delay for some users:
-
Backend cache might take up to 5 minutes to renew.
-
Frontend cache is renew when page is refreshed.