Skip to content
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

extract React specific code into subapp-react module #1485

Merged
merged 20 commits into from
Jan 3, 2020
Merged

extract React specific code into subapp-react module #1485

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
588fe15
1
jchip Jan 3, 2020
ccfa763
2
jchip Jan 3, 2020
dda2daa
3
jchip Jan 3, 2020
ac01e91
4
jchip Jan 3, 2020
ceb0e5c
5
jchip Jan 3, 2020
7981656
6
jchip Jan 3, 2020
588a867
7
jchip Jan 3, 2020
18b4854
8
jchip Jan 3, 2020
ab89b81
9
jchip Jan 3, 2020
5b155cd
10
jchip Jan 3, 2020
9cf9a4d
11
jchip Jan 3, 2020
bb35ee3
12
jchip Jan 3, 2020
e777afe
13
jchip Jan 3, 2020
c9e2438
14
jchip Jan 3, 2020
4edc37c
15
jchip Jan 3, 2020
e61e5d3
16
jchip Jan 3, 2020
5a77f5d
17
jchip Jan 3, 2020
8a2f2a3
18
jchip Jan 3, 2020
f2c9fc4
19
jchip Jan 3, 2020
32ea79e
20
jchip Jan 3, 2020
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
26 changes: 26 additions & 0 deletions packages/subapp-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,36 @@ const Component = () => {
};
```

## Support for React Router

If you want to use [react-router] in your application, then you need to install the dependencies:

- [react-router] and [react-router-dom]

ie:

```bash
npm i react-router react-router-dom
```

And then set the `useReactRouter` flag to true in your subapp:

```js
import { React, loadSubApp } from "subapp-react";

export default loadSubApp({ name: "MySubapp", Component, useReactRouter: true });
```

## License

Copyright (c) 2016-present, WalmartLabs

Licensed under the [Apache License, Version 2.0].

[apache license, version 2.0]: https://www.apache.org/licenses/LICENSE-2.0
[react-router]: https://www.npmjs.com/package/react-router
[react-router-dom]: https://www.npmjs.com/package/react-router-dom

```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Purposeful code block? I more frequently see --- at the end of the License section.


```