@openfeature/react-sdk 0.2.1-experimental → 0.2.2-experimental
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 +23 -7
- package/dist/types.d.ts +6 -16108
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,8 +16,8 @@
|
|
|
16
16
|
<img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.7.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.2.
|
|
20
|
-
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.
|
|
19
|
+
<a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.2.2-experimental">
|
|
20
|
+
<img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.2-experimental&color=blue&style=for-the-badge" />
|
|
21
21
|
</a>
|
|
22
22
|
<!-- x-release-please-end -->
|
|
23
23
|
<br/>
|
|
@@ -42,10 +42,19 @@ The OpenFeature React SDK adds React-specific functionality to the [OpenFeature
|
|
|
42
42
|
|
|
43
43
|
In addition to the feature provided by the [web sdk](https://openfeature.dev/docs/reference/technologies/client/web), capabilities include:
|
|
44
44
|
|
|
45
|
-
- [
|
|
46
|
-
- [
|
|
47
|
-
- [
|
|
48
|
-
- [
|
|
45
|
+
- [Overview](#overview)
|
|
46
|
+
- [🚀 Quick start](#-quick-start)
|
|
47
|
+
- [Requirements](#requirements)
|
|
48
|
+
- [Install](#install)
|
|
49
|
+
- [npm](#npm)
|
|
50
|
+
- [yarn](#yarn)
|
|
51
|
+
- [Required peer dependencies](#required-peer-dependencies)
|
|
52
|
+
- [Usage](#usage)
|
|
53
|
+
- [Multiple Providers and Domains](#multiple-providers-and-domains)
|
|
54
|
+
- [Re-rendering with Context Changes](#re-rendering-with-context-changes)
|
|
55
|
+
- [Re-rendering with Flag Configuration Changes](#re-rendering-with-flag-configuration-changes)
|
|
56
|
+
- [Suspense Support](#suspense-support)
|
|
57
|
+
- [Resources](#resources)
|
|
49
58
|
|
|
50
59
|
## 🚀 Quick start
|
|
51
60
|
|
|
@@ -62,11 +71,18 @@ In addition to the feature provided by the [web sdk](https://openfeature.dev/doc
|
|
|
62
71
|
npm install --save @openfeature/react-sdk
|
|
63
72
|
```
|
|
64
73
|
|
|
74
|
+
#### yarn
|
|
75
|
+
|
|
76
|
+
```sh
|
|
77
|
+
# yarn requires manual installation of the peer dependencies (see below)
|
|
78
|
+
yarn add @openfeature/react-sdk @openfeature/web-sdk @openfeature/core
|
|
79
|
+
```
|
|
80
|
+
|
|
65
81
|
#### Required peer dependencies
|
|
66
82
|
|
|
67
83
|
The following list contains the peer dependencies of `@openfeature/react-sdk` with its expected and compatible versions:
|
|
68
84
|
|
|
69
|
-
* `@openfeature/web-sdk`: >=0.4.
|
|
85
|
+
* `@openfeature/web-sdk`: >=0.4.14
|
|
70
86
|
* `react`: >=16.8.0
|
|
71
87
|
|
|
72
88
|
### Usage
|