Have ideas to improve npm?Join in the discussion! »

    octicons-vue

    1.0.10 • Public • Published

    Vue Octicons

    Installation & Usage

    NPM

    npm install --save octicons-vue
    # or with yarn
    yarn add octicons-vue

    A single octicon

    <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

    <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
    <Octicon :icon="icon" :scale="1" className="additional-class" label="another label" />

    Development & Testing

    Please check the Contributing Guidelines.

    Contribution

    Issues and PRs are welcome !

    Install

    npm i octicons-vue

    DownloadsWeekly Downloads

    150

    Version

    1.0.10

    License

    MIT

    Unpacked Size

    6.97 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar