@getflip/swirl-icons - npm Package Compare versions

Comparing version 0.27.0 to 0.28.0

dist/metadata.js

@@ -198,2 +198,13 @@ "use strict";
   },
+  "BookmarkFilled": {
+    "id": "swirl-icons-BookmarkFilled",
+    "name": "BookmarkFilled",
+    "usage": [
+      "app",
+      "admin"
+    ],
+    "keywords": [
+      "BookmarkFilled"
+    ]
+  },
   "Cancel": {
@@ -433,2 +444,24 @@ "id": "swirl-icons-Cancel",
   },
+  "DirectoryFilled": {
+    "id": "swirl-icons-DirectoryFilled",
+    "name": "DirectoryFilled",
+    "usage": [
+      "app",
+      "admin"
+    ],
+    "keywords": [
+      "DirectoryFilled"
+    ]
+  },
+  "DirectoryOutlined": {
+    "id": "swirl-icons-DirectoryOutlined",
+    "name": "DirectoryOutlined",
+    "usage": [
+      "app",
+      "admin"
+    ],
+    "keywords": [
+      "DirectoryOutlined"
+    ]
+  },
   "Discover": {
@@ -435,0 +468,0 @@ "id": "swirl-icons-Discover",

package.json

 {
   "name": "@getflip/swirl-icons",
-  "version": "0.27.0",
+  "version": "0.28.0",
   "description": "Swirl Design System Icons package contains the Flip icon SVGs and web fonts.",
@@ -5,0 +5,0 @@ "author": "Flip GmbH",

README.md

@@ -50,1 +50,16 @@ # Swirl Icons
 ```
+
+## Add or update icons
+
+All icon deliverables are generated from the svg files inside
+`packages/swirl-icons/icons`. To change, add or delete icons, modify the
+corresponding svg file.
+
+**⚠️ Every icon svg file needs to come in three sizes (16, 24, 28). The files
+have to be named in PascalCase followed by the size, e.g. `AddPhoto16.svg`!**
+
+1. Modify the icon files in a new branch
+2. Run `yarn generate`, select "icons" when prompted
+3. Run `yarn changeset` to create a corresponding changelog item
+4. Run `yarn build`
+5. Check, commit and push all changes and create a PR

No alert changes

Improved metrics

Total package byte prevSize

4170499

increased by8.8%

Number of package files

561

increased by1.63%

Lines of code

4970

increased by5.74%

Number of lines in readme file

65

increased by30%

No dependency changes