You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+46Lines changed: 46 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,52 @@ After a release, please make sure to run `bundle exec rake update_changelog`. Th
23
23
24
24
Changes since the last non-beta release.
25
25
26
+
#### Breaking Changes
27
+
28
+
-**React on Rails Core Package**: Several Pro-only methods have been removed from the core package and are now exclusively available in the `react-on-rails-pro` package. If you're using any of the following methods, you'll need to migrate to React on Rails Pro:
29
+
-`getOrWaitForComponent()`
30
+
-`getOrWaitForStore()`
31
+
-`getOrWaitForStoreGenerator()`
32
+
-`reactOnRailsStoreLoaded()`
33
+
-`streamServerRenderedReactComponent()`
34
+
-`serverRenderRSCReactComponent()`
35
+
36
+
**Migration Guide:**
37
+
38
+
To migrate to React on Rails Pro:
39
+
40
+
1. Install the Pro package:
41
+
42
+
```bash
43
+
yarn add react-on-rails-pro
44
+
# or
45
+
npm install react-on-rails-pro
46
+
```
47
+
48
+
2. Update your imports from `react-on-rails` to `react-on-rails-pro`:
49
+
50
+
```javascript
51
+
// Before
52
+
importReactOnRailsfrom'react-on-rails';
53
+
54
+
// After
55
+
importReactOnRailsfrom'react-on-rails-pro';
56
+
```
57
+
58
+
3. For server-side rendering, update your import paths:
59
+
60
+
```javascript
61
+
// Before
62
+
importReactOnRailsfrom'react-on-rails';
63
+
64
+
// After
65
+
importReactOnRailsfrom'react-on-rails-pro';
66
+
```
67
+
68
+
4. If you're using a free license for personal (non-production) use, you can obtain one at [React on Rails Pro License](https://www.shakacode.com/react-on-rails-pro). The Pro package is free for personal, educational, and non-production usage.
69
+
70
+
**Note:** If you're not using any of the Pro-only methods listed above, no changes are required.
0 commit comments