From 73e14b19e6cbe22ab127516cf9d504d30bc10624 Mon Sep 17 00:00:00 2001 From: Buzurgmehr Arjmandi Date: Sat, 21 May 2022 14:51:50 +0200 Subject: [PATCH] fix(docs): add warning about material ui styled engine change 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. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 22fd707..c3a5796 100644 --- a/README.md +++ b/README.md @@ -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"; ```