# @ritterim/platform-icons > Platform icons are part of the [Platform UI](https://github.com/ritterim/platform-ui) project from Ritter Insurance Marketing Latest version **2.1.16** (published 2024-05-28) · MIT license · 0 weekly downloads ## Install ```sh npm install @ritterim/platform-icons pnpm add @ritterim/platform-icons yarn add @ritterim/platform-icons bun add @ritterim/platform-icons ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: no vulnerabilities; has provenance. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 2.1.16 | | Published | 2024-05-28 | | First published | 2019-11-11 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 64.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 0 | | Author | Ritter Insurance Marketing | | Maintainers | ritterim | | Keywords | CSS, icon fonts, fonts | ## Links - npm: https://www.npmjs.com/package/@ritterim/platform-icons - Repository: https://github.com/ritterim/platform-icons - Homepage: https://github.com/ritterim/platform-icons#readme - Issues: https://github.com/ritterim/platform-icons/issues - npm.io page: https://npm.io/package/@ritterim/platform-icons ## Alternatives - [style-dictionary](https://npm.io/package/style-dictionary.md) — 2.0M weekly downloads - [postcss-merge-idents](https://npm.io/package/postcss-merge-idents.md) — 1.7M weekly downloads - [@fontsource/noto-sans](https://npm.io/package/@fontsource/noto-sans.md) — 93.0K weekly downloads - [uglifycss](https://npm.io/package/uglifycss.md) — 71.6K weekly downloads - [mat4-interpolate](https://npm.io/package/mat4-interpolate.md) — 23.3K weekly downloads ## Recent versions - 2.1.16 (latest) — 2024-05-28 - 2.1.15 — 2023-10-16 - 2.1.14 — 2023-09-08 - 2.1.13 — 2023-09-08 - 2.1.12 — 2023-09-07 - 2.1.11 — 2023-09-07 - 2.1.8 — 2023-07-11 - 2.1.7 — 2023-02-27 - 2.1.6 — 2023-02-01 - 2.1.5 — 2023-01-30 - 2.1.4 — 2023-01-30 - 2.1.3 — 2023-01-26 - 2.1.2 — 2023-01-20 - 2.1.0 — 2023-01-20 - 2.0.2 — 2022-01-19 - … 4 more at https://npm.io/package/@ritterim/platform-icons/versions ## README # Platform Icons Separate package for [Platform UI](https://github.com/ritterim/platform-ui) Icons ## How to use ### CDN Usage - In your projects `` section, include one of the following lines: ```html ``` ### NPM Installation - In your project, install the Platform Icons package via npm ``` npm install @ritterim/platform-icons ``` - Include in your HTML or import into your stylesheet ```html ``` ```css /* style.css */ import 'path/to/node_modules/@ritterim/platform-icons/dist/platform-icons.css' ``` - Use icons in your HTML: ```html ``` ## Dev Instructions 1. Clone repo 2. Navigate into the repo folder 3. Run `npm install` to install dependencies 4. After installing dependencies, build the project by running `npm run build` 5. To start dev server, run `npm start` 6. To create package, run `npm run pack` ## SVG Setup for Contributing Some notes on svg setup | source | default | |---|---| | artboard | 4" x 4" | | main stroke | 24pt | | auxiliary stroke | 18pt | | corner | .15" | | join | round | - Use compound paths (remember, there is no white 😜) - Expand to outlines ## Codepoints Codepoints are the hexadecimal pointer to an icon. Here, they're used to target icons in CSS using `:before`: ```html ``` Each time the icon set is generated there's a chance these pointers may shift. To avoid this, we copy `./public/platform-icons.json` map to `reserved-codepoints.json` to maintain the current label-to-codepoint map so codepoints don't change. ## Dependencies - [SVGO](https://github.com/svg/svgo) - used to optimize all SVG icons - [Fantasticon](https://github.com/tancredi/fantasticon) - used to build icon fonts - [Vite](https://github.com/vitejs/vite) - used for dev server and building library - Vite Plugins: - [vite-plugin-banner](https://github.com/chengpeiquan/vite-plugin-banner) - used to prepend licensing info - [rollup-plugin-copy](https://github.com/vladshcherbin/rollup-plugin-copy) - used to copy generated font files to the public directory - [vite-plugin-handlebars](https://github.com/alexlafroscia/vite-plugin-handlebars)- used to run the handlebars templates --- _Source: https://npm.io/package/@ritterim/platform-icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._