Code Monkey home page Code Monkey logo

vue-transformicons's Introduction

Transformicons for Vue.

Install/Usage

# Using npm
$ npm i -S vue-transformicons

# or yarn
$ yarn add vue-transformicons
<div id="#app">
  <menu-icon></menu-icon>
</div>

You can use Local Registration:

import { MenuIcon } from 'vue-transformicons'
export default {
  components: {
    MenuIcon
  }
}

or Global Registration:

import VueTransformicons from 'vue-transformicons';
Vue.use(Transformicons);

// or with a custom component name
import { MenuIcon } from 'vue-transformicons';
Vue.component('custom-name', MenuIcon);

Usage in SSR

For use this package with Nuxt or another SSR server, is necessary to use the SSR build.

import { MenuIcon } from 'vue-transformicons/dist/vue-transformicons.ssr';

Usage in browser

In browser you can use Unpkg, Jsdelivr, CDN.js, etc.

# Unpkg
https://unpkg.com/vue-transformicons@latest/dist/vue-transformicons.js

# JSDelivr
https://cdn.jsdelivr.net/npm/vue-transformicons@latest/dist/vue-transformicons.min.js

Transformicons Components

Menu Icons

Provides with Menu icons.

Parameters:

  • animation - string, optional - Sets the menu animation type. In case this parameter is not provided, it will default to butterfly. Values available:
    • butterfly
    • minus
    • x-cross
    • arrow-up
    • arrow-360-left
    • arrow-left
  • active - boolean, optional - Sets initial state for the button. Defaults to false.

Examples

<menu-icon></menu-icon>
<menu-icon animation="minus"></menu-icon>
<menu-icon animation="x-cross"></menu-icon>
<menu-icon animation="arrow-up"></menu-icon>
<menu-icon animation="arrow-left"></menu-icon>
<menu-icon animation="arrow-left" :active="true"></menu-icon>

Grid Icons

Provides with Grid icons.

Parameters:

  • animation - string, optional - Sets the menu animation type. In case this parameter is not provided, it will default to minus. Values available:
    • minus
    • check
  • active - boolean, optional - Sets initial state for the button. Defaults to false.

Examples

<grid-icon></grid-icon>
<grid-icon animation="rearrange"></grid-icon>
<grid-icon animation="collapse"></grid-icon>
<grid-icon animation="collapse" :active="true"></grid-icon>

Add Icons

Provides with Add icons.

Parameters:

  • animation - string, optional - Sets the menu animation type. In case this parameter is not provided, it will default to minus. Values available:
    • minus
    • check
  • active - boolean, optional - Sets initial state for the button. Defaults to false.

Examples

<add-icon></add-icon>
<add-icon animation="minus"></add-icon>
<add-icon animation="check"></add-icon>
<add-icon animation="minus" :active="true">

Remove Icons

Provides with Remove icons.

Parameters

  • animation - string, optional - Sets the menu animation type. In case this parameter is not provided, it will default to check. Values available:
    • check
    • chevron-left
    • chevron-right
    • chevron-down
    • chevron-up
  • active - boolean, optional - Sets initial state for the button. Defaults to false.

Examples

<remove-icon></remove-icon>
<remove-icon animation="check"></remove-icon>
<remove-icon animation="chevron-left"></remove-icon>
<remove-icon animation="chevron-right"></remove-icon>
<remove-icon animation="chevron-down"></remove-icon>
<remove-icon animation="chevron-up"></remove-icon>
<remove-icon animation="check" :active="true"></remove-icon>

Contact Icons

Provides with Contact icons.

Parameters:

  • animation - string, optional - So far, the only available animation is email.
  • active - boolean, optional - Sets initial state for the button. Defaults to false.

Examples

<contact-icon></contact-icon>
<contact-icon :active="true"></contact-icon>
<contact-icon animation="email" ></contact-icon>

Form Icons

Provides with Form icons.

Parameters:

  • animation - string, optional - So far, the only available animation is search.
  • active - boolean, optional - Sets initial state for the button. Defaults to false.

Examples

<form-icon></form-icon>
<form-icon :active="true"></form-icon>
<form-icon animation="search"></form-icon>

Video Icons

Provides with Video icons.

Parameters:

  • animation - string, optional - So far, the only available animation is play.
  • active - boolean, optional - Sets initial state for the button. Defaults to false.

Examples

<video-icon></video-icon>
<video-icon :active="true"></video-icon>
<video-icon animation="play"></video-icon>

Scroll Icon

Provides with a scroll icon.

Examples

<scroll-icon></scroll-icon>

Loader Icon

Provides with a Loader icon.

Examples

<loader-icon></loader-icon>

Community

All feedback and suggestions are welcome!

License

This is a open-source software licensed under the MIT license

vue-transformicons's People

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

djrock1987

vue-transformicons's Issues

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.