Skip to content

Commit

Permalink
fix(docs): add warning about material ui styled engine change
Browse files Browse the repository at this point in the history
This update also updates to mui v5 which requries configuring an optional style engine. Material ui will be removed in a later version but for now this will be necessary as part of a dependency upgrade. Apologies in advance for the hassle.
  • Loading branch information
b-zurg committed May 21, 2022
1 parent 4b1ef3d commit 73e14b1
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,13 @@ import { SplitPane } from "react-collapse-pane";
```

If you're using Typescript the `SplitPaneProps`, as well as a few other helper types type is also available.

NOTE: Since the upgrade to MUI v5 you need to install a peer dependency style engine. Since there is a decision between styled components and emotion I did not make this an explicit dependency.

If you want to simply use the default then follow the install guide here https://mui.com/material-ui/getting-started/installation/
If you want to use styled components then follow the configuration guide here https://mui.com/material-ui/guides/styled-engine/

In the future this dependency will be removed, apologies for the hassle while that gets sorted out. The next version will be much leaner.
```ts
import { SplitPane, SplitPaneProps, ResizerOptions, CollapseOptions, SplitPaneHooks } from "react-collapse-pane";
```
Expand Down

0 comments on commit 73e14b1

Please sign in to comment.