@bigbinary/neetoui 3.0.10 → 3.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/package.json +1 -1
- package/v2/index.css +1 -1
- package/v2/layouts.js +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,35 @@ Starting `3.0.x`, neetoUI stylesheet has been separated from the bundle. To get
|
|
|
15
15
|
@import "@bigbinary/neetoui/v2";
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
+
**NeetoUI** has few peer dependencies which are required to use NeetoUI properly. Install the peer dependencies using the below command:
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
yarn add react-toastify@8.0.2 formik@2.2.0 react-router-dom@5.2.0 react-router-nav-prompt@0.4.1
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**NeetoUI** depends on `react-toastify` for Toasters, so the styles for toaster must be imported to your main `scss` entry point.
|
|
25
|
+
|
|
26
|
+
```scss
|
|
27
|
+
@import "react-toastify/dist/ReactToastify.min.css";
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Also make sure to include `<ToastContainer />` in your application.
|
|
31
|
+
|
|
32
|
+
```jsx
|
|
33
|
+
import React from 'react';
|
|
34
|
+
|
|
35
|
+
import { ToastContainer } from 'react-toastify';
|
|
36
|
+
|
|
37
|
+
const App = () => {
|
|
38
|
+
return (
|
|
39
|
+
<>
|
|
40
|
+
<ToastContainer />
|
|
41
|
+
// Other children
|
|
42
|
+
</>
|
|
43
|
+
);
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
18
47
|
If the project uses **NeetoUI v1**, install [Remixicons](https://remixicon.com/) as **NeetoUI v1** relies on it. It can be installed by executing following command.
|
|
19
48
|
|
|
20
49
|
```
|