# octicons-modular
> Octicons with tree-shaking support and icon-per-file style
Latest version **1.0.7** (published 2021-03-09) · MIT license · 0 weekly downloads
## Install
```sh
npm install octicons-modular
pnpm add octicons-modular
yarn add octicons-modular
bun add octicons-modular
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: esm support; no vulnerabilities.
Warnings: low downloads; no types.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.7 |
| Published | 2021-03-09 |
| First published | 2017-09-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 301.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Hien Dao |
| Maintainers | hiendv |
| Keywords | icon, icons, octicons, modular, vuejs, react, component, tree-shaking, svg |
## Links
- npm: https://www.npmjs.com/package/octicons-modular
- npm.io page: https://npm.io/package/octicons-modular
## Alternatives
- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads
- [@react-md/material-icons](https://npm.io/package/@react-md/material-icons.md) — 1.6K weekly downloads
## Recent versions
- 1.0.7 (latest) — 2021-03-09
- 1.0.6 — 2020-07-03
- 1.0.5 — 2020-05-25
- 1.0.1 — 2020-01-31
- 1.0.0 — 2019-12-16
- 0.18.13 — 2019-12-16
- 0.18.12 — 2019-12-16
- 0.18.11 — 2019-12-13
- 0.18.10 — 2019-10-02
- 0.18.8 — 2019-09-12
- 0.18.6 — 2019-08-28
- 0.18.5 — 2019-08-12
- 0.18.3 — 2019-06-24
- 0.18.2 — 2019-06-24
- 0.18.1 — 2019-05-22
- … 42 more at https://npm.io/package/octicons-modular/versions
## README
# Modular Octicons
## Installation & Usage
### Direct `` include
Load the UMD module [main.umd.min.js](https://cdn.jsdelivr.net/npm/octicons-modular@latest/lib/main.umd.min.js), `Octicons` will be registered as a global variable and the CSS is automatically injected.
```js
Octicons.alert.html()
// ''
```
#### CDN
[](https://www.jsdelivr.com/package/npm/octicons-modular)
```html
```
[unpkg.com](https://unpkg.com/octicons-modular)
```html
```
**Note: We recommend linking to a specific version number that you can update manually**
### NPM
```bash
npm install --save octicons-modular
# or with yarn
yarn add octicons-modular
```
```js
// import the stylesheet
require('octicons-modular/lib/main.css')
// 1. import a single icon
const markGithub = require('octicons-modular/lib/icons/mark-github')
// import markGithub from 'octicons-modular/lib/icons/mark-github'
// import { markGithub } from 'octicons-modular'
markGithub.html()
// ''
// 2. or the whole library
const Octicons = require('octicons-modular')
// import * as Octicons from 'octicons-modular'
Octicons.alert.html()
// ''
```
### API
#### `attrs(options)`
Returns attributes of the SVGSVGElement
+ options (object, optional) - Render options
+ scale (integer, optional): Scale
+ Default: 1
+ label (string, optional): Label
+ Default: null
+ class (string, optional): Additional class
+ Default: null
#### `html(options)`
Returns an SVGSVGElement
+ options (object, optional) - Render options. Same as `attrs` options.
#### `path()`
Returns path attributes
#### `keywords()`
Return icon keywords
```js
icon.html({
scale: 1 // Scale the SVG
label: 'very fast' // Set the aria-label attribute
class: 'an-additional-class' // Add a custom class
})
```
#### Tree-shaking
The library does support tree-shaking. See [the tests](test/tree-shaking) with rollup & webpack.
## Development & Testing
Please check the [Contributing Guidelines](https://github.com/hiendv/octicons-modular/blob/master/CONTRIBUTING.md).
## Contribution
Issues and PRs are welcome !
---
_Source: https://npm.io/package/octicons-modular · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._