Add useFeatureFlag to esm-react-utils public exports (#734)

openmrs · Jul 18, 2023 · 2dcac98 · 2dcac98
1 parent 1148f7b
commit 2dcac98
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/packages/framework/esm-framework/docs/API.md b/packages/framework/esm-framework/docs/API.md
@@ -102,6 +102,7 @@
 
 - [getFeatureFlag](API.md#getfeatureflag)
 - [registerFeatureFlag](API.md#registerfeatureflag)
+- [useFeatureFlag](API.md#usefeatureflag)
 
 ### Framework Functions
 
@@ -2633,6 +2634,39 @@ It can then be used to turn on or off features in the code.
 
 ___
 
+### useFeatureFlag
+
+▸ **useFeatureFlag**(`flagName`): `boolean`
+
+Use this function to tell whether a feature flag is toggled on or off.
+
+Example:
+
+```tsx
+import { useFeatureFlag } from "@openmrs/esm-react-utils";
+
+export function MyComponent() {
+ const isMyFeatureFlagOn = useFeatureFlag("my-feature-flag");
+ return <>{isMyFeatureFlagOn && <ExperimentalFeature />}</>;
+}
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `flagName` | `string` |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/framework/esm-react-utils/src/useFeatureFlag.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useFeatureFlag.ts#L19)
+
+___
+
 ## Framework Functions
 
 ### getAsyncExtensionLifecycle

diff --git a/packages/framework/esm-react-utils/src/public.ts b/packages/framework/esm-react-utils/src/public.ts
@@ -13,6 +13,7 @@ export * from "./useConnectivity";
 export * from "./usePatient";
 export * from "./useExtensionSlotMeta";
 export * from "./useExtensionStore";
+export * from "./useFeatureFlag";
 export * from "./useLayoutType";
 export * from "./useLocations";
 export * from "./useOnClickOutside";