@openfeature/react-sdk 0.3.2-experimental → 0.3.2
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/README.md +14 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,12 +12,12 @@
|
|
|
12
12
|
<!-- x-hide-in-docs-end -->
|
|
13
13
|
<!-- The 'github-badges' class is used in the docs -->
|
|
14
14
|
<p align="center" class="github-badges">
|
|
15
|
-
<a href="https://github.com/open-feature/spec/releases/tag/v0.
|
|
16
|
-
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.
|
|
15
|
+
<a href="https://github.com/open-feature/spec/releases/tag/v0.8.0">
|
|
16
|
+
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
|
|
17
17
|
</a>
|
|
18
18
|
<!-- x-release-please-start-version -->
|
|
19
|
-
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.3.2
|
|
20
|
-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.3.2
|
|
19
|
+
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.3.2">
|
|
20
|
+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.3.2&color=blue&style=for-the-badge" />
|
|
21
21
|
</a>
|
|
22
22
|
<!-- x-release-please-end -->
|
|
23
23
|
<br/>
|
|
@@ -34,8 +34,6 @@
|
|
|
34
34
|
|
|
35
35
|
<!-- x-hide-in-docs-end -->
|
|
36
36
|
|
|
37
|
-
🧪 This SDK is experimental.
|
|
38
|
-
|
|
39
37
|
## Overview
|
|
40
38
|
|
|
41
39
|
The OpenFeature React SDK adds React-specific functionality to the [OpenFeature Web SDK](https://openfeature.dev/docs/reference/technologies/client/web).
|
|
@@ -83,10 +81,11 @@ yarn add @openfeature/react-sdk @openfeature/web-sdk @openfeature/core
|
|
|
83
81
|
|
|
84
82
|
#### Required peer dependencies
|
|
85
83
|
|
|
86
|
-
The following list contains the peer dependencies of `@openfeature/react-sdk
|
|
84
|
+
The following list contains the peer dependencies of `@openfeature/react-sdk`.
|
|
85
|
+
See the [package.json](./package.json) for the required versions.
|
|
87
86
|
|
|
88
|
-
* `@openfeature/web-sdk
|
|
89
|
-
* `react
|
|
87
|
+
* `@openfeature/web-sdk`
|
|
88
|
+
* `react`
|
|
90
89
|
|
|
91
90
|
### Usage
|
|
92
91
|
|
|
@@ -294,6 +293,12 @@ To scope an OpenFeatureProvider to a particular provider/context set the `domain
|
|
|
294
293
|
</OpenFeatureProvider>
|
|
295
294
|
```
|
|
296
295
|
|
|
296
|
+
> I can import things form the `@openfeature/react-sdk`, `@openfeature/web-sdk`, and `@openfeature/core`; which should I use?
|
|
297
|
+
|
|
298
|
+
The `@openfeature/react-sdk` re-exports everything from its peers (`@openfeature/web-sdk` and `@openfeature/core`), and adds the React-specific features.
|
|
299
|
+
You can import everything from the `@openfeature/react-sdk` directly.
|
|
300
|
+
Avoid importing anything from `@openfeature/web-sdk` or `@openfeature/core`.
|
|
301
|
+
|
|
297
302
|
## Resources
|
|
298
303
|
|
|
299
304
|
- [Example repo](https://github.com/open-feature/react-test-app)
|