@openmrs/esm-framework 5.0.3-pre.903 → 5.0.3-pre.905
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +2 -2
- package/dist/openmrs-esm-framework.js +1 -1
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +34 -0
- package/package.json +15 -15
package/docs/API.md
CHANGED
|
@@ -102,6 +102,7 @@
|
|
|
102
102
|
|
|
103
103
|
- [getFeatureFlag](API.md#getfeatureflag)
|
|
104
104
|
- [registerFeatureFlag](API.md#registerfeatureflag)
|
|
105
|
+
- [useFeatureFlag](API.md#usefeatureflag)
|
|
105
106
|
|
|
106
107
|
### Framework Functions
|
|
107
108
|
|
|
@@ -2633,6 +2634,39 @@ It can then be used to turn on or off features in the code.
|
|
|
2633
2634
|
|
|
2634
2635
|
___
|
|
2635
2636
|
|
|
2637
|
+
### useFeatureFlag
|
|
2638
|
+
|
|
2639
|
+
▸ **useFeatureFlag**(`flagName`): `boolean`
|
|
2640
|
+
|
|
2641
|
+
Use this function to tell whether a feature flag is toggled on or off.
|
|
2642
|
+
|
|
2643
|
+
Example:
|
|
2644
|
+
|
|
2645
|
+
```tsx
|
|
2646
|
+
import { useFeatureFlag } from "@openmrs/esm-react-utils";
|
|
2647
|
+
|
|
2648
|
+
export function MyComponent() {
|
|
2649
|
+
const isMyFeatureFlagOn = useFeatureFlag("my-feature-flag");
|
|
2650
|
+
return <>{isMyFeatureFlagOn && <ExperimentalFeature />}</>;
|
|
2651
|
+
}
|
|
2652
|
+
```
|
|
2653
|
+
|
|
2654
|
+
#### Parameters
|
|
2655
|
+
|
|
2656
|
+
| Name | Type |
|
|
2657
|
+
| :------ | :------ |
|
|
2658
|
+
| `flagName` | `string` |
|
|
2659
|
+
|
|
2660
|
+
#### Returns
|
|
2661
|
+
|
|
2662
|
+
`boolean`
|
|
2663
|
+
|
|
2664
|
+
#### Defined in
|
|
2665
|
+
|
|
2666
|
+
[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)
|
|
2667
|
+
|
|
2668
|
+
___
|
|
2669
|
+
|
|
2636
2670
|
## Framework Functions
|
|
2637
2671
|
|
|
2638
2672
|
### getAsyncExtensionLifecycle
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openmrs/esm-framework",
|
|
3
|
-
"version": "5.0.3-pre.
|
|
3
|
+
"version": "5.0.3-pre.905",
|
|
4
4
|
"license": "MPL-2.0",
|
|
5
5
|
"browser": "dist/openmrs-esm-framework.js",
|
|
6
6
|
"main": "src/index.ts",
|
|
@@ -36,19 +36,19 @@
|
|
|
36
36
|
"access": "public"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@openmrs/esm-api": "^5.0.3-pre.
|
|
40
|
-
"@openmrs/esm-breadcrumbs": "^5.0.3-pre.
|
|
41
|
-
"@openmrs/esm-config": "^5.0.3-pre.
|
|
42
|
-
"@openmrs/esm-dynamic-loading": "^5.0.3-pre.
|
|
43
|
-
"@openmrs/esm-error-handling": "^5.0.3-pre.
|
|
44
|
-
"@openmrs/esm-extensions": "^5.0.3-pre.
|
|
45
|
-
"@openmrs/esm-feature-flags": "^5.0.3-pre.
|
|
46
|
-
"@openmrs/esm-globals": "^5.0.3-pre.
|
|
47
|
-
"@openmrs/esm-offline": "^5.0.3-pre.
|
|
48
|
-
"@openmrs/esm-react-utils": "^5.0.3-pre.
|
|
49
|
-
"@openmrs/esm-state": "^5.0.3-pre.
|
|
50
|
-
"@openmrs/esm-styleguide": "^5.0.3-pre.
|
|
51
|
-
"@openmrs/esm-utils": "^5.0.3-pre.
|
|
39
|
+
"@openmrs/esm-api": "^5.0.3-pre.905",
|
|
40
|
+
"@openmrs/esm-breadcrumbs": "^5.0.3-pre.905",
|
|
41
|
+
"@openmrs/esm-config": "^5.0.3-pre.905",
|
|
42
|
+
"@openmrs/esm-dynamic-loading": "^5.0.3-pre.905",
|
|
43
|
+
"@openmrs/esm-error-handling": "^5.0.3-pre.905",
|
|
44
|
+
"@openmrs/esm-extensions": "^5.0.3-pre.905",
|
|
45
|
+
"@openmrs/esm-feature-flags": "^5.0.3-pre.905",
|
|
46
|
+
"@openmrs/esm-globals": "^5.0.3-pre.905",
|
|
47
|
+
"@openmrs/esm-offline": "^5.0.3-pre.905",
|
|
48
|
+
"@openmrs/esm-react-utils": "^5.0.3-pre.905",
|
|
49
|
+
"@openmrs/esm-state": "^5.0.3-pre.905",
|
|
50
|
+
"@openmrs/esm-styleguide": "^5.0.3-pre.905",
|
|
51
|
+
"@openmrs/esm-utils": "^5.0.3-pre.905",
|
|
52
52
|
"dayjs": "^1.10.7"
|
|
53
53
|
},
|
|
54
54
|
"peerDependencies": {
|
|
@@ -66,5 +66,5 @@
|
|
|
66
66
|
"jest-environment-jsdom": "28.1.0",
|
|
67
67
|
"webpack": "^5.88.0"
|
|
68
68
|
},
|
|
69
|
-
"gitHead": "
|
|
69
|
+
"gitHead": "ecb9bc8ba8ea622143dd2e231cfb3117da31e982"
|
|
70
70
|
}
|