This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@rightbraintechbd/vue-awesome-icon-picker

1.1.0 • Public • Published

VueAwesomeIconPicker

A Vue.js icon picker component to easily pick a FontAwesome 5 Icon & use it.

print screen

print screen

Table of contents

Installation

Install using npm

npm install --save @rightbraintechbd/vue-awesome-icon-picker

OR use it via cdn

<script src="https://unpkg.com/@rightbraintechbd/vue-awesome-icon-picker@1.1.0/dist/vue-awesome-icon-picker.min.js"></script>

Then Register The Component Globally:

import Vue from 'vue';
import VueAwesomeIconPicker from '@rightbraintechbd/vue-awesome-icon-picker';

Vue.component('vue-awesome-icon-picker', VueAwesomeIconPicker)

OR use it in a Component:

import VueAwesomeIconPicker from '@rightbraintechbd/vue-awesome-icon-picker';

export default {
    name: 'YourAwesomeComponent',
    components: {
        'vue-awesome-icon-picker': VueAwesomeIconPicker
    },
}

Usage

Use it like:

<vue-awesome-icon-picker />

Configuration

You can also pass Options as props in the vue-awesome-icon-picker component as you can see the example below

<vue-awesome-icon-picker :icon-preview="false" />

Remember that all options are optional and you can check the default values below:

Options

/**
 * The Text which will be shown to the Select Icon Button
 */
button: {
    type: String,
    default: 'Pick A Icon'
},
/**
 * Header Title
 */
title: {
    type: String,
    default: 'Vue Awesome Icon Picker'
},
/**
 * Whether the Icon should displayed or not
 */
iconPreview: {
    type: Boolean,
    default: true
}

Events

VueAwesomeIconPicker will emit a selected(icon) event when user selects an icon.

<vue-awesome-icon-picker @selected="onIconSelected" />
{
    methods: {
        onIconSelected(icon) {
            // your code here
        }
    }
}

It will emit an Object containing icon data like { type, name }

{ type: 'fab', name: 'facebook' }

MIT

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Published

Version History

  • Version
    Downloads (Last 7 Days)
    • Published

Package Sidebar

Install

npm i @rightbraintechbd/vue-awesome-icon-picker

Weekly Downloads

63

Version

1.1.0

License

MIT

Unpacked Size

125 kB

Total Files

7

Last publish

Collaborators

  • who_jonson