# themify-icons

> Themify Icons SCSS

Latest version **1.0.0** (published 2016-01-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install themify-icons
pnpm add themify-icons
yarn add themify-icons
bun add themify-icons
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-01-05 |
| First published | 2016-01-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Maintainers | melbourne2991 |

## Links

- npm: https://www.npmjs.com/package/themify-icons
- Repository: https://github.com/aastrong/themify-icons.scss
- Homepage: https://github.com/aastrong/themify-icons.scss#readme
- Issues: https://github.com/aastrong/themify-icons.scss/issues
- npm.io page: https://npm.io/package/themify-icons

## Recent versions

- 1.0.0 (latest) — 2016-01-05

## README

Themify Icons SCSS
==================

This is a SCSS version of the Themify Icons which includes mixins to create themify icons on the fly. I am basing the SCSS off of the SCSS verion of font-awesome. You can find themify icons here: [http://themify.me/themify-icons](http://themify.me/themify-icons)

##Install
1. Download and put the themify-icons folder inside of your SASS folder.
2. Include themify in your main sass file  

	```
	@import 'themify-icons/themify-icons';

	```
3. Use as you wish

## About
This is currently in development, if you wish to help, please comment, fork, create issues, w/e you need.


## Usage
There are a few available variables you may use, below are some usages.

### Basic
This is the most basic usage. By default your icon will be displayed as a :before of your selected div. By default, your icon will be given  a font size of 18px, a margin right or left of 10px and a color of inherit.

```
.mydiv { @include icon($apple);  }
```

### Display after
This will display the icon as a :after on your selected div

```
.mydiv { @include iconafter($apple); }
```

### Variables
There are 3 variables currently set up for the icon: font-size, color, and margin. Below are their different uses:

#### All of them together (icon, margin, font-size, color)

```
.mydiv { @include icon($apple, 20px, 20px, $green); }
```

#### Just font size
```
.mydiv { @include icon($apple, $fs:20px); }
```
#### Just margin
```
.mydiv { @include icon($apple, $m:10px); }
```
#### Just color
```
.mydiv { @include icon($apple, $c:$purple); }
```
#### Removing defaults

```
.mydiv { @include icon($apple, null, null, $blue)
```

#### Available variables are
$fs for font-size

$m for margin

$c for color

---
_Source: https://npm.io/package/themify-icons · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._