Giter Club home page Giter Club logo

vue-octicons's Introduction

vue-octicons

NPM version

GitHub Octicons packaged as Vue components

Why should I use this library?

I created this library for 2 main reasons:

  1. I wasn't happy with other libraries for Octicons in Vue out there; they felt too complicated
  2. No other libraries for Octicons in Vue that I could find came with type definitions

This library was created mainly to solve those issues by staying simple and generating a type defenitions file on build.

Install

npm install @brattonross/vue-octicons

Usage

// Import only what you need
import { AlertIcon, SearchIcon } from '@brattonross/vue-octicons';

Sizing

You can customise the size of the icons using the size prop.

Setting a size using a multiplier (converts the multiplier to em):

<alert-icon size="1.5x"></alert-icon>

Setting a size directly in px:

<alert-icon size="24"></alert-icon>

Inspiration

I was inspired to create this package when I saw egoist's vue-feather-icons. Please check out their repo for another great icon set.

vue-octicons's People

Contributors

brattonross avatar dependabot-preview[bot] avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.