Skip to content

Add basic migration docs to changelog #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
internettrans merged 3 commits into from
Sep 6, 2025
Merged

Add basic migration docs to changelog #220

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54345e3
Add basic migration docs to changelog
internettrans Sep 6, 2025
9d6765a
Add props argument to docs
internettrans Sep 6, 2025
a3a7414
Self review
internettrans Sep 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,30 @@
- feature: Re-implement <Parcel /> component 15d55b1 ([#218](https://github.com/single-spa/single-spa-react/pull/218)) by Jolyn
- breaking: Remove main, module, and require fields from package.json 15d55b1 ([#218](https://github.com/single-spa/single-spa-react/pull/218)) by Jolyn
- breaking: Rewrite to typescript. New opts required. Newer versions of React required 15d55b1 ([#218](https://github.com/single-spa/single-spa-react/pull/218)) by Jolyn
- breaking: returns `init` function rather than `bootstrap` function, which is compatible with single-spa@7 or with earlier versions of single-spa via the [`@single-spa/lifecycles-compat`](https://github.com/single-spa/lifecyles-compat) library

### Upgrading

```diff
-export const { bootstrap, mount, unmount } = singleSpaReact({
- React,
- ReactDOMClient,
- rootComponent,
- errorBoundary(err, info, props) {
- // https://reactjs.org/docs/error-boundaries.html
- return <div>This renders when a catastrophic error occurs</div>;
- },
-});

+export const { init, mount, unmount } = singleSpaReact({
+ createRoot,
+ createElement,
+ useEffect,
+ renderReactNode: (props) => (
+ <Root />
+ )
+});
```

## 6.0.2

Expand Down