https://github.com/farbelous/fontawesome-iconpicker

Font Awesome Icon Picker component for Bootstrap.
https://github.com/farbelous/fontawesome-iconpicker

bootstrap chrome-extension font fontawesome fontawesome-icons fontawesome5 icon-picker javascript js

Last synced: 3 months ago
JSON representation

Font Awesome Icon Picker component for Bootstrap.

• Host: GitHub
• URL: https://github.com/farbelous/fontawesome-iconpicker
• Owner: itsjavi
• License: mit
• Archived: true
• Created: 2014-06-15T13:02:49.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-06-04T18:08:09.000Z (over 4 years ago)
• Last Synced: 2024-04-13T06:33:56.753Z (7 months ago)
• Topics: bootstrap, chrome-extension, font, fontawesome, fontawesome-icons, fontawesome5, icon-picker, javascript, js
• Language: JavaScript
• Homepage: https://itsjavi.com/fontawesome-iconpicker/
• Size: 2.41 MB
• Stars: 559
• Watchers: 29
• Forks: 196
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
fontawesome-iconpicker

========================

[![npm](https://img.shields.io/npm/v/fontawesome-iconpicker.svg?style=flat-square)](https://www.npmjs.com/package/fontawesome-iconpicker)

Font Awesome Icon Picker is a fully customizable plugin for Twitter Bootstrap,

with a powerful base API, based on [bootstrap-popover-picker](https://itsjavi.github.io/bootstrap-popover-picker/)

You can use Font Awesome 5 or another font icon set of your choice (icon list is totally customizable).

[View demos](https://itsjavi.github.io/fontawesome-iconpicker/)

## Instantiation

You can call the plugin in several ways:

```javascript

// Create instance if not exists (returns a jQuery object)

$('.my').iconpicker();

$('.my').iconpicker({ /*options*/ }); // you can also specify options via data-* attributes

// For the first matched element, access to a plugin property value

$('.my').data('iconpicker').iconpickerProperty;

// For the first matched element, call a plugin instance method with the given args

$('.my').data('iconpicker').iconpickerMethod('methodArg1', 'methodArg2' /* , other args */);

// Call and apply a plugin method to EACH matched element.

$.iconpicker.batch('.my', 'iconpickerMethod', 'methodArg1', 'methodArg2' /* , other args */); ->

```

## Triggered Events

All of them exposes the plugin instance through event.iconpickerInstance

In order of call:

* iconpickerCreate

* iconpickerCreated

* iconpickerShow

* iconpickerShown

* iconpickerSelect (also exposes event.iconpickerItem and event.iconpickerValue)

* iconpickerUpdate

* iconpickerInvalid (also exposes event.iconpickerValue)

* iconpickerSetValue (also exposes event.iconpickerValue)

* iconpickerSetSourceValue (also exposes event.iconpickerValue)

* iconpickerUpdated

* iconpickerSelected (also exposes event.iconpickerItem and event.iconpickerValue)

* iconpickerHide

* iconpickerHidden

* iconpickerDestroy

* iconpickerDestroyed

```javascript

// Bind iconpicker events to the element

$('.my').on('iconpickerSelected', function(event){

  /* event.iconpickerValue */

});

```

## Popover placement extensions

This plugin comes with more placement options than the original Bootstrap Popover.

Here are all the possibilities in detail:

            1 2 3 4 5

            G       6

            F       7

            E       8

            D C B A 9

    0.      inline (no placement, display as inline-block)

    1.      topLeftCorner

    2.      topLeft

    3.      top (center)

    4.      topRight

    5.      topRightCorner

    6.      rightTop

    7.      right (center)

    8.      rightBottom

    9.      bottomRightCorner

    A.      bottomRight

    B.      bottom (center)

    C.      bottomLeft

    D.      bottomLeftCorner

    E.      leftBottom

    F.      left (center)

    G.      leftTop

## Available options

```javascript

var options = {

    title: false, // Popover title (optional) only if specified in the template

    selected: false, // use this value as the current item and ignore the original

    defaultValue: false, // use this value as the current item if input or element value is empty

    placement: 'bottom', // (has some issues with auto and CSS). auto, top, bottom, left, right

    collision: 'none', // If true, the popover will be repositioned to another position when collapses with the window borders

    animation: true, // fade in/out on show/hide ?

    //hide iconpicker automatically when a value is picked. it is ignored if mustAccept is not false and the accept button is visible

    hideOnSelect: false,

    showFooter: false,

    searchInFooter: false, // If true, the search will be added to the footer instead of the title

    mustAccept: false, // only applicable when there's an iconpicker-btn-accept button in the popover footer

    selectedCustomClass: 'bg-primary', // Appends this class when to the selected item

    icons: [], // list of icon objects [{title:String, searchTerms:String}]. By default, all Font Awesome icons are included.

    fullClassFormatter: function(val) {

        return 'fa ' + val;

    },

    input: 'input,.iconpicker-input', // children input selector

    inputSearch: false, // use the input as a search box too?

    container: false, //  Appends the popover to a specific element. If not set, the selected element or element parent is used

    component: '.input-group-addon,.iconpicker-component', // children component jQuery selector or object, relative to the container element

    // Plugin templates:

    templates: {

        popover: '


' +

            '




',

        footer: '
',

        buttons: 'Cancel' +

            ' Accept',

        search: '',

        iconpicker: '
',

        iconpickerItem: '',

    }

};

```