https://github.com/animify/minicons
💅 Aesthetic open-source SVG icons based on a 24x24 grid.
https://github.com/animify/minicons
icons iconset javascript svg
Last synced: 5 months ago
JSON representation
💅 Aesthetic open-source SVG icons based on a 24x24 grid.
- Host: GitHub
- URL: https://github.com/animify/minicons
- Owner: animify
- License: mit
- Created: 2017-10-21T14:42:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-11-15T22:40:20.000Z (almost 3 years ago)
- Last Synced: 2025-05-12T21:48:35.409Z (5 months ago)
- Topics: icons, iconset, javascript, svg
- Language: JavaScript
- Homepage: https://minicons.netlify.com/
- Size: 489 KB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Minicons
[](https://travis-ci.org/animify/Minicons)
[](https://codeclimate.com/github/animify/Minicons/maintainability)
## About Minicons
Minicons is an open-source SVG icon set drafted on an 24x24 sized grid aimed at unifying icon design across a website. Currently the first release is covering several categories of icons (86 total).
[View available icons](https://minicons.netlify.app)
## Table of contents
1. [Features](#features)
2. [Getting Minicons](#getting-minicons)
1. [CDN](#cdn)
2. [ZIP](#download-the-zip)
3. [NPM](#using-npm)
3. [Quick start](#download-the-zip)
4. [API](#api)
1. [Properties](#properties)
- [`minicons.icons`](#miniconsicons)
- [`minicons.config`](#miniconsconfig)
2. [Methods](#methods)
- [`minicons.find()`](#miniconsfindname)
- [`minicons.create()`](#miniconscreatename-props)
- [`minicons.swap()`](#miniconsswap)
5. [Contributing guidelines](#building)
5. [License](#license)
## Features
* Dead simple to set up
* Icon swap when an element is dynamically added
* Extensive, straight forward icon object API
* Over 80+ icons
* Uniform design
* Easily configurable
## Getting Minicons
### CDN
You can directly import minicons.js from the CDN:
```
https://unpkg.com/minicons@latest/dist/minicons.js
```
CDN links are also supported for older specified versions:
```
https://unpkg.com/minicons@_VERSION_/dist/minicons.js
```
### Download the ZIP
[Download](https://github.com/animify/Minicons/releases/latest) the latest release.
### Using NPM
Install Minicons using CDN
```
npm i minicons -S
```
This will create all dist files in the Minicons package folder in your roots' node modules.
```
├── dist/
├── icons/
├── minicons.js
├── minicons.min.js
└── minicons.json
```
## Quick start
Get up and running within minutes inside your browser.
#### 1. Include
Include the CDN or the path to minicons.js at the end of your closing `