npm - proicons - Versions diffs - 4.9.0 → 4.10.0 - Mend

proicons 4.9.0 → 4.10.0

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.

Files changed (14) hide show

package/LICENSE CHANGED Viewed

@@ -1,21 +1,21 @@
-MIT License
-Copyright (c) 2024 ProCode
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+Copyright (c) 2024 ProCode
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md CHANGED Viewed

@@ -1,100 +1,108 @@
-# ProIcons
-<img src="https://raw.githubusercontent.com/ProCode-Software/proicons/main/.github/images/github-cover_light.png#gh-light-mode-only">
-<img src="https://raw.githubusercontent.com/ProCode-Software/proicons/main/.github/images/github-cover_dark.png#gh-dark-mode-only">
-<p align="center">
-    <a href="https://github.com/ProCode-Software/proicons/releases">
-        <img src="https://img.shields.io/npm/v/proicons?style=for-the-badge&color=orange"
-            alt="NPM Version">
-    </a>
-    <a href="">
-        <img src="https://img.shields.io/github/stars/ProCode-Software/proicons?style=for-the-badge"
-            alt="Stars">
-    </a>
-    <a href="https://www.npmjs.com/package/proicons">
-        <img src="https://img.shields.io/npm/dm/proicons?label=downloads&amp;style=for-the-badge"
-            alt="NPM Package">
-    </a>
-    <a href="https://github.com/ProCode-Software/proicons/blob/main/LICENSE">
-        <img src="https://img.shields.io/github/license/ProCode-Software/proicons?style=for-the-badge"
-            alt="License">
-    </a>
-</p>
-<p align="center">
-    <b>A collection of 400+ modern and open-source icons and logos</b>
-    <br>
-    <a href="https://procode-software.github.io/proicons">Icons</a> |
-    <a href="https://github.com/ProCode-Software/proicons/wiki">Documentation</a> |
-    <a href="https://github.com/ProCode-Software/proicons">GitHub</a> |
-    <a href="https://www.npmjs.com/package/proicons">NPM Package</a>
-</p>
-> **Work in progress**
->
-> Most of the website and planned packages aren't currently finished, but you can start using the beta package right now on NPM. See [ROADMAP.md](/ROADMAP.md) to learn more.
-## Usage
-### Node.js
-1. Install the ProIcons package via [NPM](https://www.npmjs.com/package/proicons):
-```
-npm install proicons
-```
-2. Use ProIcons inside JavaScript
-```javascript
-import proicons from 'proicons';
-// Refer to the icon
-proicons.icons.add;
-```
-_or_
-```html
-<!-- Insert the icon -->
-<i proicon="add"></i>
-<script src="path/to/proicons/dist/proicons.js"></script>
-<!-- Replace icons with SVG -->
-<script>
-    proicons.replace();
-</script>
-```
-### HTML
-If you are not inside a Node environment, you can import the ProIcons script via a CDN provider
-```html
-<!-- Insert the icon -->
-<i proicon="add"></i>
-<script src="https://unpkg.com/proicons"></script>
-<!-- Replace icons with SVG -->
-<script>
-    proicons.replace();
-</script>
-```
-## License
-ProIcons is MIT-licensed, giving you peace of mind using these icons in your project. Learn more [here](./LICENSE)
-> [!WARNING]
-> This library contains brand icons that may not be MIT-licensed and may have additional terms and guidelines. Learn more [here](https://procode-software.github.io/proicons/docs/introduction/about#usage-of-brand-icons)
-## Credits
--   Icon design and guidelines inspired by Microsoft's [Fluent System Icons](https://github.com/microsoft/fluentui-system-icons)
--   Alpha bleeding script from https://github.com/Corecii/Transparent-Pixel-Fix
--   API based on [Feather Icons](https://github.com/feathericons/feather)
-<img src="https://img.shields.io/badge/dynamic/json?label=icons&style=for-the-badge&prefix=%20&query=%24%5B%3F(%40.length)%5D&url=https://raw.githubusercontent.com/ProCode-Software/proicons/main/src/configs/icons.json" alt="Number of icons currently in the library"/>
+# ProIcons
+<img src="https://raw.githubusercontent.com/ProCode-Software/proicons/main/.github/images/github-cover_light.png#gh-light-mode-only">
+<img src="https://raw.githubusercontent.com/ProCode-Software/proicons/main/.github/images/github-cover_dark.png#gh-dark-mode-only">
+<p align="center">
+    <a href="https://github.com/ProCode-Software/proicons/releases">
+        <img src="https://img.shields.io/github/v/release/ProCode-Software/proicons?style=for-the-badge&color=orange"
+            alt="Version">
+    </a>
+    <a href="">
+        <img src="https://img.shields.io/github/stars/ProCode-Software/proicons?style=for-the-badge"
+            alt="Stars">
+    </a>
+    <a href="https://www.npmjs.com/package/proicons">
+        <img src="https://img.shields.io/npm/dm/proicons?label=downloads&amp;style=for-the-badge"
+            alt="NPM Package">
+    </a>
+    <a href="https://github.com/ProCode-Software/proicons/blob/main/LICENSE">
+        <img src="https://img.shields.io/github/license/ProCode-Software/proicons?style=for-the-badge"
+            alt="License">
+    </a>
+</p>
+<p align="center">
+    <b>A collection of 400+ modern and open-source icons and logos</b>
+    <br>
+    <a href="https://procode-software.github.io/proicons">Icons</a> |
+    <a href="https://procode-software.github.io/proicons/docs/introduction/about">Documentation</a> |
+    <a href="https://github.com/ProCode-Software/proicons">GitHub</a> |
+    <a href="https://www.npmjs.com/package/proicons">NPM Package</a>
+</p>
+> **Work in progress**
+>
+> Most of the website and planned packages aren't currently finished, but you can start using the beta package right now on NPM. See [ROADMAP.md](/ROADMAP.md) to learn more.
+## Usage
+### Node.js
+1. Install the ProIcons package via [NPM](https://www.npmjs.com/package/proicons):
+```
+npm install proicons
+```
+2. Use ProIcons inside JavaScript
+```javascript
+import { icons } from 'proicons';
+// or
+const { icons } = require('proicons')
+// Refer to the icon
+icons.add;
+```
+_or_
+```html
+<!-- Insert the icon -->
+<i proicon="add"></i>
+<script src="path/to/proicons/dist/umd/proicons.cjs"></script>
+<!-- Replace icons with SVG -->
+<script>
+    proicons.replace();
+</script>
+```
+### HTML
+You can import the ProIcons package via a CDN provider
+```html
+<!-- Insert the icon -->
+<i proicon="add"></i>
+<script src="https://unpkg.com/proicons"></script>
+<!-- Replace icons with SVG -->
+<script>
+    proicons.replace();
+</script>
+```
+### Packages
+ProIcons is also available in the following packages:
+- **[Webfont](https://procode-software.github.io/proicons/docs/packages/webfont):** Use ProIcons on your website as a webfont, similar to Font Awesome, without the need of scripts.
+## License
+ProIcons is MIT-licensed, giving you peace of mind using these icons in your project. Learn more [here](./LICENSE)
+> [!WARNING]
+> This library contains brand icons that may not be MIT-licensed and may have additional terms and guidelines. Learn more [here](https://procode-software.github.io/proicons/docs/introduction/about#usage-of-brand-icons)
+## Contributing
+For more info on how to contribute, please see our [contributing guide](https://github.com/ProCode-Software/proicons/blob/main/CONTRIBUTING.md).
+## Credits
+-   Icon design and guidelines inspired by Microsoft's [Fluent System Icons](https://github.com/microsoft/fluentui-system-icons)
+-   Alpha bleeding script from https://github.com/Corecii/Transparent-Pixel-Fix
+-   API based on [Feather Icons](https://github.com/feathericons/feather)
+-   Website design inspired by [Lucide](https://github.com/lucide-icons/lucide) and built using [VitePress](https://github.com/vuejs/vitepress)

package/lib/interfaces.d.ts CHANGED Viewed

@@ -21,11 +21,17 @@ export interface ProIconReplaceConfig {
     useAttributes: false;
 }
 export declare class ProIconInfo {
+    /** The name of the icon in Friendly Form */
     name: string;
+    /** The name of the icon in kebab-case */
     kebabCase: string;
+    /** The name of the icon in camelCase */
     camelCase: string;
+    /** The icon as an `SVGSVGElement`. Use the `outerHTML` property on this to return the icon as a string. */
     element: SVGSVGElement;
+    /** The category of the icon. */
     category: string;
+    /** An array of the icon's tags. */
     tags: string[];
     /**
      *

package/lib/proicons.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import icons from './configs/icons.json';
+import icons from './icons';
 import categories from './categories';
 import replace from './replace';
 import getIconInfo from './getIconInfo';

package/lib/search.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
 import { ProIconInfo } from "./interfaces";
 /** Searches for icons with names or tags that contain `key` and returns them as `ProIconInfo`. */
-declare function search(key: string): ProIconInfo[];
+declare function search(query: string): ProIconInfo[];
 export default search;

package/package.json CHANGED Viewed

@@ -1,82 +1,90 @@
-{
-  "name": "proicons",
-  "version": "4.9.0",
-  "description": "A collection of 400+ modern and open-source icons",
-  "type": "module",
-  "main": "dist/cjs/proicons.cjs",
-  "main:umd": "dist/umd/proicons.cjs",
-  "unpkg": "dist/umd/proicons.cjs",
-  "module": "dist/proicons.js",
-  "typings": "lib/proicons.d.ts",
-  "amdName": "proicons",
-  "files": [
-    "dist",
-    "lib"
-  ],
-  "exports": {
-    ".": {
-      "import": "./dist/esm/proicons.js",
-      "require": "./dist/cjs/proicons.cjs",
-      "types": "./lib/proicons.d.ts",
-      "default": "./dist/umd/proicons.cjs"
-    }
-  },
-  "workspaces": [
-    "packages/*",
-    "tools/BuildIconList/"
-  ],
-  "repository": {
-    "url": "ProCode-Software/proicons"
-  },
-  "homepage": "https://github.com/ProCode-Software/proicons",
-  "bugs": "https://github.com/ProCode-Software/proicons/issues",
-  "scripts": {
-    "dev": "vite",
-    "icons:build": "node ./bin/build.js",
-    "build": "tsc && vite build",
-    "preview": "vite preview",
-    "docs:dev": "vitepress dev site/src --port 9000",
-    "docs:build": "vitepress build site/src",
-    "docs:preview": "vitepress preview site/src",
-    "prepack": "node ./bin/publish.js"
-  },
-  "keywords": [
-    "icons",
-    "icon-pack",
-    "js",
-    "feather",
-    "lucide",
-    "fluent",
-    "font awesome",
-    "svg",
-    "proicons",
-    "procode"
-  ],
-  "author": "ProCode Software",
-  "license": "MIT",
-  "devDependencies": {
-    "@twbs/fantasticon": "^3.0.0",
-    "@types/node": "^22.3.0",
-    "@types/rollup": "^0.54.0",
-    "@types/webpack": "^5.28.5",
-    "@webpack-cli/generators": "^3.0.7",
-    "ansi-colors": "^4.1.3",
-    "chalk": "^5.3.0",
-    "d3-delaunay": "^6.0.4",
-    "html-webpack-plugin": "^5.6.0",
-    "jimp": "^1.4.0",
-    "prettier": "^3.3.3",
-    "progress": "^2.0.3",
-    "rollup-plugin-dts": "^6.1.1",
-    "sharp": "^0.33.5",
-    "svg2ttf": "^6.0.3",
-    "svgo": "^3.3.2",
-    "ts-loader": "^9.5.1",
-    "typescript": "^5.5.4",
-    "vite": "^5.4.5",
-    "vite-plugin-html": "^3.2.2",
-    "vitepress": "^1.3.4",
-    "webpack": "^5.93.0",
-    "webpack-dev-server": "^5.0.4"
-  }
-}
+{
+  "name": "proicons",
+  "version": "4.10.0",
+  "description": "A collection of 400+ modern and open-source icons",
+  "type": "module",
+  "main": "dist/cjs/proicons.cjs",
+  "main:umd": "dist/umd/proicons.cjs",
+  "module": "dist/es/proicons.js",
+  "typings": "lib/proicons.d.ts",
+  "amdName": "proicons",
+  "unpkg": "dist/umd/proicons.cjs",
+  "jsdelivr": "dist/umd/proicons.cjs",
+  "browser": "dist/umd/proicons.cjs",
+  "files": [
+    "dist",
+    "lib"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/es/proicons.js",
+      "require": "./dist/cjs/proicons.cjs",
+      "types": "./lib/proicons.d.ts",
+      "default": "./dist/umd/proicons.cjs"
+    }
+  },
+  "workspaces": [
+    "packages/*",
+    "tools/*",
+    "site"
+  ],
+  "repository": {
+    "url": "ProCode-Software/proicons"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/ProCode-Software/proicons",
+  "bugs": "https://github.com/ProCode-Software/proicons/issues",
+  "keywords": [
+    "icons",
+    "icon-pack",
+    "js",
+    "feather",
+    "lucide",
+    "fluent",
+    "font awesome",
+    "svg",
+    "proicons",
+    "procode"
+  ],
+  "author": "ProCode Software",
+  "license": "MIT",
+  "devDependencies": {
+    "@twbs/fantasticon": "^3.0.0",
+    "@types/node": "^22.7.5",
+    "adm-zip": "^0.5.16",
+    "ansi-colors": "^4.1.3",
+    "chalk": "^5.3.0",
+    "d3-delaunay": "^6.0.4",
+    "jimp": "^1.6.0",
+    "minisearch": "^7.1.0",
+    "oslllo-svg-fixer": "^5.0.0",
+    "piscina": "^4.7.0",
+    "prettier": "^3.3.3",
+    "progress": "^2.0.3",
+    "sass-embedded": "^1.79.5",
+    "sharp": "^0.33.5",
+    "svg2ttf": "^6.0.3",
+    "svgo": "^3.3.2",
+    "typescript": "^5.6.3",
+    "vite": "^5.4.9",
+    "vite-plugin-html": "^3.2.2",
+    "vitepress": "^1.4.1",
+    "vue": "^3.5.12",
+    "@proicons/cli": "1.0.0"
+  },
+  "scripts": {
+    "dev": "pnpm vite",
+    "icons:build": "node --no-deprecation ./bin/build.js",
+    "icons:optimize": "pnpm run icons:build -o",
+    "icons:build-frozen": "pnpm run icons:build -l",
+    "icons:build-rebuild": "pnpm run icons:build -r",
+    "font:build": "pnpm run icons:build -f",
+    "build": "pnpm tsc && pnpm vite build",
+    "preview": "pnpm vite preview",
+    "docs:dev": "pnpm vitepress dev site/src --port 9000",
+    "docs:build": "pnpm vitepress build site/src",
+    "docs:preview": "pnpm vitepress preview site/src"
+  }
+}