@instructure/ui-icons 8.37.1-snapshot-2 → 8.37.1-snapshot-3

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [8.37.1-snapshot-2](https://github.com/instructure/instructure-ui/compare/v8.37.0...v8.37.1-snapshot-2) (2023-05-08)
+## [8.37.1-snapshot-3](https://github.com/instructure/instructure-ui/compare/v8.37.0...v8.37.1-snapshot-3) (2023-05-08)
 
 **Note:** Version bump only for package @instructure/ui-icons
 

package/README.md

@@ -33,13 +33,64 @@ const MyComponent = () => {
 
 - Copy the new icon files in the `/svg/Solid` and `/svg/Line` directories.
 
-- Run `yarn export:icons` from the repository root directory to generate the SVG files.
+- Double-check that the SVG size is 1920x1920.
+
+```html
+<svg
+  width="1920"
+  height="1920"
+  viewBox="0 0 1920 1920"
+  fill="none"
+  xmlns="http://www.w3.org/2000/svg"
+>
+  {...}
+</svg>
+```
+
+- The files cannot contain [clipping paths](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/clipPath)! Sadly, when the Designers export icons from Figma, most of the time they have a clipping path around the whole canvas. If the source code has them, manually refactor the code, e.g:
+
+```html
+// Before:
+<svg
+  width="1920"
+  height="1920"
+  viewBox="0 0 1920 1920"
+  fill="none"
+  xmlns="http://www.w3.org/2000/svg"
+>
+  <g clip-path="url(#clip0_1007_24)">
+    <path d="..." fill="#2D3B45" />
+  </g>
+  <defs>
+    <clipPath id="clip0_1007_24">
+      <rect width="1920" height="1920" fill="white" />
+    </clipPath>
+  </defs>
+</svg>
+
+// After:
+<svg
+  width="1920"
+  height="1920"
+  viewBox="0 0 1920 1920"
+  fill="none"
+  xmlns="http://www.w3.org/2000/svg"
+>
+  <path d="..." fill="#2D3B45" />
+</svg>
+```
+
+- If the icon has to bidirectional (being mirrored in RTL mode, typically arrow icons), add the icon name to the bidirectional list in `packages/ui-icons/icons.config.js`. Deprecated icons are handled here as well.
+
+- Run `yarn export:icons` from the repository root directory to generate the icons. This script will also take care of further optimizations on the SVG files (e.g. removing the `fill`s). The configs for this are located in `packages/ui-icons-build/lib/tasks/optimize-svgs/index.js` and `packages/ui-icons/svgo.config.js`.
 
 - Run `yarn && yarn bootstrap`.
 
 - Finally, run `yarn dev` from the repository root directory to start the local server and check the generated output.
 
-- Verify icons display correctly by checking under `iconography` in the main nav
+- Verify icons display correctly by checking under [iconography](/#iconography) in the main nav. Check all 3 versions (React, SVG and icon font).
+
+(Note: The fonts are sometimes not rendered correctly, but we decided not to fix them, because they are not really used anywhere, and we might stop supporting icon fonts in the future in general.)
 
 ### Guidelines for Drawing Icons
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-icons",
-  "version": "8.37.1-snapshot-2",
+  "version": "8.37.1-snapshot-3",
   "description": "Icon set for Instructure, Inc. products",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -22,13 +22,13 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.37.1-snapshot-2",
-    "@instructure/ui-icons-build": "8.37.1-snapshot-2",
+    "@instructure/ui-babel-preset": "8.37.1-snapshot-3",
+    "@instructure/ui-icons-build": "8.37.1-snapshot-3",
     "gulp": "^4.0.2"
   },
   "dependencies": {
     "@babel/runtime": "^7.21.0",
-    "@instructure/ui-svg-images": "8.37.1-snapshot-2",
+    "@instructure/ui-svg-images": "8.37.1-snapshot-3",
     "prop-types": "^15.8.1"
   },
   "peerDependencies": {