@esri/calcite-ui-icons 3.28.9 → 3.29.1-next.0

package/LICENSE.md

@@ -1,14 +1,13 @@
-# License
+# Licensing
 
-COPYRIGHT © 2021 Esri
+COPYRIGHT © 2024 Esri
 
 All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
 
-See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
+See use restrictions at <http://www.esri.com/legal/pdfs/mla_e204_e300/english>
 
 For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
 
-email: contracts@esri.com
-
+email: <contracts@esri.com>

package/README.md

@@ -1,7 +1,7 @@
 # calcite-ui-icons
 
 A collection of UI SVG icons created by Esri for mapping applications.
-https://esri.github.io/calcite-ui-icons/
+<https://developers.arcgis.com/calcite-design-system/icons/>
 
 ## Installation
 
@@ -13,15 +13,16 @@ Icons use an outlined style. Some icons include an additional filled version.
 
 Every concept has 3 sizes:
 
-* **16x16**
-* **24x24**
-* **32x32**
+- **16x16**
+- **24x24**
+- **32x32**
 
 ### Why 3 Sizes?
 
 More info on what happens when you scale vector based icons [here](https://github.com/Esri/calcite-ui-icons/wiki/What-Happens-When-You-Scale-Vector-Based-Icons)
 
 ### Outline icons are the standard
+
 Outline icons have the default name. For example, `trash-16.svg` will render the default outline icon.
 
 Some icons have alternative states for toggling or greater flexibility. For those icons, appending `-f` (`information-16-f.svg`) will render the filled version.
@@ -30,16 +31,17 @@ Some icons have alternative states for toggling or greater flexibility. For thos
 
 For web apps, the easiest way to use calcite-ui-icons is with [calcite-components](https://github.com/Esri/calcite-components). The [calcite-icon](https://github.com/Esri/calcite-components/tree/master/src/components/calcite-icon) component will handle fetching and rendering any icon from this set with the following api:
 
-```
+```html
 <calcite-icon icon="arrowLeft" scale="m"></calcite-icon>
 ```
 
 ### Sprite packages
+
 Furthermore, sprites are available in 3 packages and live outside the `icons/` directory:
 
-* sprite-16.svg
-* sprite-24.svg
-* sprite-32.svg
+- sprite-16.svg
+- sprite-24.svg
+- sprite-32.svg
 
 Alternative filled versions of the outlined icons have `-f` appended to their name, and are included in the sprites above.
 
@@ -68,7 +70,7 @@ Some icons use multiple paths and opacity in their construction, for these the d
 ```js
 import { imageLayer16 } from "@esri/calcite-ui-icons/js/imageLayer16.js";
 
-console.log(imageLayer16) // => [{ path: "M16 6v3H5.035l5 5H6.5L0 7.5 6.5 1h3.536l-5 5z", opacity: .4 }, ...]
+console.log(imageLayer16); // => [{ path: "M16 6v3H5.035l5 5H6.5L0 7.5 6.5 1h3.536l-5 5z", opacity: .4 }, ...]
 ```
 
 **Note**: It is not recommended to import the entire library of icons. This will have negative performance implications. Use the technique above to select only the icons your users actually need to download.
@@ -82,7 +84,7 @@ Types are also available for projects leveraging TypeScript. `CalciteIconPath` d
 All icons are also provided as part of a JSON file. If you installed via npm, you can import the full icon data set using the following:
 
 ```js
-var calciteIcons = require('@esri/calcite-ui-icons/docs/icons.json');
+var calciteIcons = require("@esri/calcite-ui-icons/docs/icons.json");
 ```
 
 This will give you an object containing all the icons in the library at all sizes:
@@ -110,18 +112,20 @@ This will give you an object containing all the icons in the library at all size
   }
 }
 ```
-_Note: path data omitted for brevity_.
 
-Most icons will have simple strings as path data, but some will be more complex as they need to store not only path, but opacity as well for multiple shapes. Icons of this structure will be anotated with the `multiPath` flag.
+*Note: path data omitted for brevity.*
+
+Most icons will have simple strings as path data, but some will be more complex as they need to store not only path, but opacity as well for multiple shapes. Icons of this structure will be annotated with the `multiPath` flag.
 
 ### Individual icons structure
+
 All the individual SVG icons have a common file structure.
 
 This is what the `close-16.svg` looks like:
 
 ```html
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16">
-  <path d="M0 10V7h10.965l-5-5H9.5L16 8.5 9.5 15H5.964l5-5H0z"/>
+  <path d="M0 10V7h10.965l-5-5H9.5L16 8.5 9.5 15H5.964l5-5H0z" />
 </svg>
 ```
 
@@ -153,43 +157,34 @@ npm install
 
 Then:
 
-* To create Xcode image sets (for use with iOS, macOS, iPadOS) with a default size:
+- To create Xcode image sets (for use with iOS, macOS, iPadOS) with a default size:
 
-    ```sh
-    npm run convert-all-ios
-    ```
+  ```sh
+  npm run convert-all-ios
+  ```
 
-* To create Xcode image sets with a specified size (e.g. 44x44):
+- To create Xcode image sets with a specified size (e.g. 44x44):
 
-    ```sh
-    npm run convert-all-ios:size 44
-    ```
+  ```sh
+  npm run convert-all-ios:size 44
+  ```
 
-* To create versions for use on desktop in one size:
+- To create versions for use on desktop in one size:
 
-    ```sh
-    npm run convert-all-desktop:size 64
-    ```
+  ```sh
+  npm run convert-all-desktop:size 64
+  ```
 
-* To create versions for use on desktop in sizes ranging from 16 to 64, run:
+- To create versions for use on desktop in sizes ranging from 16 to 64, run:
 
-    ```sh
-    npm run convert-all-desktop-multi
-    ```
+  ```sh
+  npm run convert-all-desktop-multi
+  ```
 
 ## Licensing
 
-COPYRIGHT © 2020 Esri
-
-All rights reserved under the copyright laws of the United States and applicable international laws, treaties, and conventions.
-
-This material is licensed for use under the Esri Master License Agreement (MLA), and is bound by the terms of that agreement. You may redistribute and use this code without modification, provided you adhere to the terms of the MLA and include this copyright notice.
-
-See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
-
-For additional information, contact: Environmental Systems Research Institute, Inc. Attn: Contracts and Legal Services Department 380 New York Street Redlands, California, USA 92373 USA
-
-email: contracts@esri.com
+Please read [LICENSE.md](./LICENSE.md)
 
 ## Contributing
-Please read the [contribute document](CONTRIBUTE.md).
+
+Please read [CONTRIBUTING.md](./CONTRIBUTING.md)