lewis-dun/fontawesome-iconpicker

Font Awesome Icon Picker 是一个用于 Twitter Bootstrap 的图标选择插件

dev-master 2024-03-01 12:34 UTC

This package is auto-updated.

Last update: 2024-09-30 13:44:44 UTC


README

npm

Font Awesome Icon Picker 是一个完全可定制的用于 Twitter Bootstrap 的插件,基于强大的基础 API,基于 bootstrap-popover-picker

您可以使用 Font Awesome 5 或您选择的任何字体图标集(图标列表可以完全自定义)。

查看演示

实例化

您可以通过多种方式调用插件

// 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 */); ->

触发事件

所有这些都会通过 event.iconpickerInstance 暴露插件实例

调用顺序

  • iconpickerCreate
  • iconpickerCreated
  • iconpickerShow
  • iconpickerShown
  • iconpickerSelect(同时也暴露 event.iconpickerItem 和 event.iconpickerValue)
  • iconpickerUpdate
  • iconpickerInvalid(同时也暴露 event.iconpickerValue)
  • iconpickerSetValue(同时也暴露 event.iconpickerValue)
  • iconpickerSetSourceValue(同时也暴露 event.iconpickerValue)
  • iconpickerUpdated
  • iconpickerSelected(同时也暴露 event.iconpickerItem 和 event.iconpickerValue)
  • iconpickerHide
  • iconpickerHidden
  • iconpickerDestroy
  • iconpickerDestroyed
// Bind iconpicker events to the element
$('.my').on('iconpickerSelected', function(event){
  /* event.iconpickerValue */
});

弹出位置扩展

此插件比原始 Bootstrap Popover 提供更多的放置选项。以下是所有可能性的详细说明

        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

可用选项

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: '<div class="iconpicker-popover popover"><div class="arrow"></div>' +
            '<div class="popover-title"></div><div class="popover-content"></div></div>',
        footer: '<div class="popover-footer"></div>',
        buttons: '<button class="iconpicker-btn iconpicker-btn-cancel btn btn-default btn-sm">Cancel</button>' +
            ' <button class="iconpicker-btn iconpicker-btn-accept btn btn-primary btn-sm">Accept</button>',
        search: '<input type="search" class="form-control iconpicker-search" placeholder="Type to filter" />',
        iconpicker: '<div class="iconpicker"><div class="iconpicker-items"></div></div>',
        iconpickerItem: '<a role="button" href="#" class="iconpicker-item"><i></i></a>',
    }
};