monday-ui-style - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

package.json

 {
   "name": "monday-ui-style",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Monday UI CSS Foundations",
@@ -11,6 +11,5 @@ "main": "dist/index.css",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build-icons": "svg2react-icon --keep-colors src/Icons dist/Icons",
     "compile-styles": "node-sass --output-style expanded --precision 6 ./src/index.scss dist/index.css",
     "css-minify": "cleancss --level 1 --format breaksWith=lf --output dist/index.min.css dist/index.css",
-    "build": "npm run build-icons && npm run compile-styles && npm run css-minify"
+    "build": "npm run compile-styles && npm run css-minify"
   },
@@ -42,5 +41,4 @@ "peerDependencies": {
     "node-sass": "^4.14.1",
-    "prettier": "^2.0.5",
-    "svg2react-icon": "^3.1.174"
+    "prettier": "^2.0.5"
   }
 }

README.md

@@ -5,2 +5,4 @@ # monday.com UI styles
 
+Although we are using React this library will try to stay framework agnostic, we are exposing here the foundations of our design system so they could be used regardless the framework/environment you are using. 
+
 ## Installation
@@ -12,8 +14,13 @@ ```
 ## Usage
-We are building the icons using [Wix's svg2react-icon](https://github.com/wix/svg2react-icon) npm package it is generating a React component for each icon
+__Styles__: Import the css file in order to have the css variables exposed on the root level
+``` scss
+@import "~monday-ui-style/dist/index.min.css";
+```
+
+__Icons__: We expose each icon's SVG from the dist files so you could use them in your app.
 ``` javascript
-import { IconName } from "monday-ui-style/dist/Icons"
-import IconName from "monday-ui-style/dist/Icons/IconName"
+import IconName from "monday-ui-style/src/Icons/IconName.svg";
 ```
 
+
 ## Adding a new icon
@@ -20,0 +27,0 @@ When adding a new icon please make sure of the following

src/Icons/iconsMetaData.js

 export const iconsMetaData = [
   {
     name: "Group",
+    file: "Group.svg",
     description: "Adding a group to a board",
@@ -8,9 +9,11 @@ },
     name: "Close",
-    description: "Close icons for inputs",
+    file: "Close.svg",
+    description: "Close",
   },
   {
-    name: "SearchThin",
+    name: "Search Thin",
+    file: "SearchThin.svg",
     description:
-      "Magnifier icons - for search inputs and general search icon buttons",
+      "Search Items",
   },
 ];

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

3

decreased by-25%

Number of lines in readme file

34

increased by25.93%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

31278

decreased by-8.89%

Number of package files

18

decreased by-18.18%

Lines of code

252

decreased by-19.23%

No dependency changes