Experimental features
An experimental feature describes functionality that's part of the code, but not available to users yet. For example, such functionality may not be displayed in a UI or there may be a condition that prevents code execution.
⚠️ Repository forks
In your repository fork or mirror, you may decide to enable experimental features yourself. However, note that the functionality is likely still in development and may be incomplete or not fully tested. If you enable an experimental feature, you do so at your own risk.
New experimental feature
To create a new experimental feature, carry out the following steps:
- Open feature-flags.config.
- Add a new flag. Each flag should use an environment variable to determine whether or not it's active. Example:
myFlag: process.env?.MY_FLAG === '1' - Add the flag as a condition to the code you want to guard. The flag is accessible via
useRuntimeConfig().public.<myFlag>.
💡 Opt-in
If you want to allow users to opt in to the feature, create a site setting for it.