Wrapper library of Microsofts Azure App Configuration SDK for JavaScript for Vue.js applications.
npm install @4com/vue-azure-app-configuration
yarn add @4com/vue-azure-app-configuration
Install the plugin by adding it to your main.js.
import { VueAzureAppConfiguration } from '@4com/vue-azure-app-configuration'
Vue.use(VueAzureAppConfiguration, { see configuration options })
The following options can be passed within the second object parameter when installing the plugin.
| Option | Description |
|---|---|
connectionString |
For authenticating the client using a connection string. |
featureFlagLabel |
The default feature flag label used as a fallback if no label argument is passed to any of the getFeatureFlagAsync() or isFeatureFlagEnabledAsync() methods, or the feature-flag component. |
Access the options passed when installing the plugin in components at this.$azureAppConfig.options.
| Example | Description |
|---|---|
<feature-flag name="MyFeatureFlag" label="Label" user="me@example.com"> |
Conditionally renders the element based on whether the feature flag with the provided name and (optional) label is enabled for the (optional) specified user. The label property overrides the featureFlagLabel if provided in the plugin options. |
Call the following global methods from components at this.$azureAppConfig.
| Signature | Description |
|---|---|
getFeatureFlagAsync(name, label) |
Gets the feature flag with the passed name and (optional) label. Returns the ConfigurationSetting<FeatureFlagValue>. Returns null if the feature flag is not found. |
isFeatureFlagEnabledAsync(name, label) |
Returns true when the feature flag with the passed name and (optional) label is enabled. Returns false when the feature flag is not found. |
isFeatureFlagEnabledForUserAsync(name, label, user) |
Returns true when the feature flag with the passed name and (optional) label is enabled for the (optional) specified user. Returns false when the feature flag is not found. |
This library currently only provides instance methods and a component for ease with using feature flags.
However, the AppConfigurationClient is exposed at this.$azureAppConfig.client.
This library currently only supports authentication using a connection string.
The sandbox can be used while developing and testing out features of the library. It uses BootstrapVue components.
Use yarn serve to start the sandbox live reload server.