# octicons-vue

> Vue component for octicons-modular

Latest version **1.0.11** (published 2021-06-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install octicons-vue
pnpm add octicons-vue
yarn add octicons-vue
bun add octicons-vue
```

## 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.11 |
| Published | 2021-06-28 |
| First published | 2018-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.8 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-vue
- npm.io page: https://npm.io/package/octicons-vue

## Dependencies (1)

- [octicons-modular](https://npm.io/package/octicons-modular.md) ^1.0.7

## 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.11 (latest) — 2021-06-28
- 1.0.10 — 2021-06-03
- 1.0.7 — 2021-03-09
- 1.0.6 — 2020-07-03
- 1.0.5 — 2020-05-25
- 1.0.4 — 2020-04-24
- 1.0.2 — 2020-03-25
- 1.0.1 — 2020-01-31
- 1.0.0 — 2019-12-16
- 0.18.14 — 2019-12-16
- 0.18.11 — 2019-12-13
- 0.18.10 — 2019-10-02
- 0.18.9 — 2019-09-12
- 0.18.8 — 2019-09-12
- 0.18.6 — 2019-08-28
- … 34 more at https://npm.io/package/octicons-vue/versions

## README

# Vue Octicons
## Installation & Usage
### NPM
```bash
npm install --save octicons-vue
# or with yarn
yarn add octicons-vue
```

#### A single octicon
```vue
<script>
const { Octicon, markGithub } = require('octicons-vue')
// import Octicon, { markGithub } from 'octicons-vue'

new Vue({
  el: '#app',
  components: { Octicon },
  data: {
    markGithub
  }
})
</script>
<template>
  <Octicon :icon="markGithub" />
</template>
```
#### All octicons
```vue
<script>
const { Octicon, Octicons } = require('octicons-vue')
// import Octicon, { Octicons } from 'octicons-vue'

new Vue({
  el: '#app',
  components: { Octicon },
  data: {
    Octicons
  }
})
</script>
<template>
  <Octicon :icon="Octicons.alert" />
</template>
```

### API
#### Props

+ icon (object) - Octicon from `octicons-modular` library
+ scale (number) - Scale
    + Default: 1
+ className (string) - Additional classes
    + Default: null
+ label (string) - Label
    + Default: null

```vue
<Octicon :icon="icon" :scale="1" className="additional-class" label="another label" />
```

## 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-vue · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._