@bigbinary/neetoui 3.1.5 → 3.2.1
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 +6 -20
- package/{v2 → build}/36bdad5d6f5ec143521a5bed31c71282.png +0 -0
- package/build/formik.js +2 -0
- package/{v2 → build}/formik.js.LICENSE.txt +0 -0
- package/{v2 → build}/index.css +1 -1
- package/build/index.js +2 -0
- package/{v2 → build}/index.js.LICENSE.txt +0 -0
- package/build/layouts.js +2 -0
- package/build/layouts.js.LICENSE.txt +17 -0
- package/jsconfig.json +1 -1
- package/package.json +3 -5
- package/webpack.config.js +1 -1
- package/v2/formik.js +0 -2
- package/v2/index.js +0 -2
- package/v2/layouts.js +0 -2
- package/v2/layouts.js.LICENSE.txt +0 -13
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ This would install `neetoui` package inside your application.
|
|
|
12
12
|
Starting `3.0.x`, neetoUI stylesheet has been separated from the bundle. To get the styles working, please import the neetoUI stylesheet to your main `scss` entry point.
|
|
13
13
|
|
|
14
14
|
```scss
|
|
15
|
-
@import "@bigbinary/neetoui
|
|
15
|
+
@import "@bigbinary/neetoui";
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
**NeetoUI** has few peer dependencies which are required to use NeetoUI properly. Install the peer dependencies using the below command:
|
|
@@ -30,9 +30,9 @@ yarn add react-toastify@8.0.2 formik@2.2.0 react-router-dom@5.2.0 react-router-n
|
|
|
30
30
|
Also make sure to include `<ToastContainer />` in your application.
|
|
31
31
|
|
|
32
32
|
```jsx
|
|
33
|
-
import React from
|
|
33
|
+
import React from "react";
|
|
34
34
|
|
|
35
|
-
import { ToastContainer } from
|
|
35
|
+
import { ToastContainer } from "react-toastify";
|
|
36
36
|
|
|
37
37
|
const App = () => {
|
|
38
38
|
return (
|
|
@@ -41,19 +41,7 @@ const App = () => {
|
|
|
41
41
|
// Other children
|
|
42
42
|
</>
|
|
43
43
|
);
|
|
44
|
-
}
|
|
45
|
-
```
|
|
46
|
-
|
|
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.
|
|
48
|
-
|
|
49
|
-
```
|
|
50
|
-
yarn add remixicon
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
Then import the Remixicon styles in your `application.scss` file by doing
|
|
54
|
-
|
|
55
|
-
```
|
|
56
|
-
import 'remixicon/fonts/remixicon.css'
|
|
44
|
+
};
|
|
57
45
|
```
|
|
58
46
|
|
|
59
47
|
## Development
|
|
@@ -66,7 +54,7 @@ yarn
|
|
|
66
54
|
|
|
67
55
|
You can create new components in the `lib/components` and export them from `lib/index.js`.
|
|
68
56
|
|
|
69
|
-
Running the `yarn
|
|
57
|
+
Running the `yarn storybook` command starts a storybook app. Use this application to test out changes. Note that nothing in the `stories` folder will be bundled with NeetoUI.
|
|
70
58
|
|
|
71
59
|
## Building
|
|
72
60
|
|
|
@@ -76,9 +64,7 @@ NeetoUI gets auto-published to npm on new commit to master. You can checkout the
|
|
|
76
64
|
|
|
77
65
|
Read the docs here
|
|
78
66
|
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
v2 : https://neetoui-v2.netlify.app
|
|
67
|
+
https://neetoui.netlify.app
|
|
82
68
|
|
|
83
69
|
## Theming
|
|
84
70
|
|
|
File without changes
|