App Configuration React client SDK

App Configuration service provides SDK to integrate with your React applications.

Integrating client SDK for React

App Configuration React client SDK can be used with all the major browsers. You can evaluate the values of your feature flag and property by integrating the App Configuration SDK.

Install the SDK.

npm install ibm-appconfiguration-react-client-sdk@latest

Initialize the sdk to connect with your App Configuration service instance. Wrapping your app component with AppConfigProvider lets you access features & properties from any level of your component hierarchy.
```
import { withAppConfigProvider } from 'ibm-appconfiguration-react-client-sdk';

(async () => {
const AppConfigProvider = await withAppConfigProvider({
   region: 'us-south',
   guid: '<guid>',
   apikey: '<apikey>',
   collectionId: 'airlines-webapp',
   environmentId: 'dev'
})

ReactDOM.render(
   <AppConfigProvider>
      <YourApp />
   </AppConfigProvider>,
   document.getElementById('root')
);
})();
```
Where:
- region: Region where the service instance is created. Use us-south for Dallas, us-east for Washington DC, eu-gb for London, eu-de for Frankfurt and au-syd for Sydney.
- guid: Instance ID of the App Configuration service. Get it from the service credentials section of the App Configuration service dashboard.
- apikey: API key of the App Configuration service. Get it from the service credentials section of the App Configuration service dashboard.
- collectionId: ID of the collection created in App Configuration service instance under the Collections section.
- environmentId: ID of the environment created in App Configuration service instance under the Environments section.

Ensure to create the service credentials of the role Client SDK for using with the React client SDK. API key of the Client SDK role has minimal access permissions that are suitable to use in browser based applications.

Examples for using feature and property-related APIs

See the following examples for using the feature-related APIs.

Get single feature

import { useFeature } from 'ibm-appconfiguration-react-client-sdk';
const feature = useFeature('feature_id')

if(feature) {
   console.log(`Feature Name ${feature.getFeatureName()} `);
   console.log(`Feature Id ${feature.getFeatureId()} `);
   console.log(`Feature Type ${feature.getFeatureDataType()} `);
   console.log(`Feature is enabled ${feature.isEnabled()} `);
}

Get all features

import { useFeatures } from 'ibm-appconfiguration-react-client-sdk';

const features = useFeatures();
const feature = features["feature_id"];

if(feature) {
   console.log(`Feature Name ${feature.getFeatureName()}`);
   console.log(`Feature Id ${feature.getFeatureId()}`);
   console.log(`Feature Type ${feature.getFeatureDataType()}`);
   console.log(`Feature is enabled ${feature.isEnabled()}`);
}

Evaluate a feature

You can use the feature.getCurrentValue(entityId, entityAttributes) method to evaluate the value of the feature flag. This method returns one of the Enabled/Disabled/Overridden value based on the evaluation. The data type of returned value matches that of feature flag. Pass a unique entityId as the parameter to perform the feature flag evaluation.

const entityId = 'john_doe';
const entityAttributes = {
   city: 'Bangalore',
   country: 'India',
};

const featureValue = feature.getCurrentValue(entityId, entityAttributes);

Where:

entityId: Id of the Entity. This will be a string identifier related to the Entity against which the feature is evaluated. For any entity to interact with App Configuration, it must provide a unique entity ID.
entityAttributes: A JSON object consisting of the attribute name and their values that defines the specified entity. This is an optional parameter if the feature flag is not configured with any targeting definition. If the targeting is configured, then entityAttributes should be provided for the rule evaluation. An attribute is a parameter that is used to define a segment. The SDK uses the attribute values to determine if the specified entity satisfies the targeting rules, and returns the appropriate feature flag value.

Get single property

import { useProperty } from 'ibm-appconfiguration-react-client-sdk';

const property = useProperty('check-in-charges');

if(property) {
   console.log(`Property Name ${property.getPropertyName()}`);
   console.log(`Property Id ${property.getPropertyId()}`);
   console.log(`Property Type ${property.getPropertyDataType()}`);
}

Get all properties

import { useProperties } from 'ibm-appconfiguration-react-client-sdk';

const properties = useProperties();

const property = properties["property_id"];

if(property) {
   console.log(`Property Name ${property.getPropertyName()}`);
   console.log(`Property Id ${property.getPropertyId()}`);
   console.log(`Property Type ${property.getPropertyDataType()}`);
}

Evaluate a property

Use the property.getCurrentValue(entityId, entityAttributes) method to evaluate the value of the property. This method returns the default property value or its overridden value based on the evaluation. The data type of returned value matches that of property.

const entityId = 'john_doe';
const entityAttributes = {
   city: 'Bangalore',
   country: 'India',
   };

const propertyValue = property.getCurrentValue(entityId, entityAttributes);

Where:

entityId: Id of the Entity. This will be a string identifier related to the Entity against which the property is evaluated. For any entity to interact with App Configuration, it must provide a unique entity ID.
entityAttributes: A JSON object consisting of the attribute name and their values that defines the specified entity. This is an optional parameter if the property is not configured with any targeting definition. If the targeting is configured, then entityAttributes should be provided for the rule evaluation. An attribute is a parameter that is used to define a segment. The SDK uses the attribute values to determine if the specified entity satisfies the targeting rules, and returns the appropriate property value.

Supported data types

You can configure feature flags and properties with App Configuration, supporting the following data types: Boolean, Numeric, and String. The String data type can be in the format of a text string, JSON, or YAML. The SDK processes each format as shown in the table.

Table 1. Example outputs
Feature or Property value	Data type	Data format	Type of data returned by `getCurrentValue()`	Example output
`true`	BOOLEAN	not applicable	`boolean`	`true`
`25`	NUMERIC	not applicable	`number`	`25`
"a string text"	STRING	TEXT	`string`	`a string text`
`{"firefox": {` `"name": "Firefox",` `"pref_url": "about:config"` }}	STRING	JSON	`org.json.JSONObject`	`{"firefox":{"name":"Firefox","pref_url":"about:config"}}`
`men:` `- John Smith` `- Bill Jones` `women:` `- Mary Smith` `- Susan Williams`	STRING	YAML	`java.lang.String`	`"men: John Smith Bill Jones\women: Mary Smith Susan Williams"`

Feature flag usage example

const feature = useFeature('json-feature');
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // JSON

// Example (traversing the returned JSON)
let result = feature.getCurrentValue(entityId, entityAttributes);
console.log(result.key) // prints the value of the key

const feature = useFeature('yaml-feature');
feature.getFeatureDataType(); // STRING
feature.getFeatureDataFormat(); // YAML
feature.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check above table)

Property usage example

const property = useProperty('json-property');
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // JSON

// Example (traversing the returned JSON)
let result = property.getCurrentValue(entityId, entityAttributes);
console.log(result.key) // prints the value of the key

const property = useProperty('yaml-property');
property.getPropertyDataType(); // STRING
property.getPropertyDataFormat(); // YAML
property.getCurrentValue(entityId, entityAttributes); // returns the stringified yaml (check above table)

Listen to the feature or property changes

The SDK automatically subscribes to event-based mechanism and re-renders the enclosed components when feature flag's or property's configuration changes.