# @assuradeurengilde/fontawesome-iconpicker 中文文档

规范地址：https://npmcn.com/package/%40assuradeurengilde/fontawesome-iconpicker/

版本：3\.2\.3
npm 元数据更新时间：2022-05-24T11:49:28.344Z
中文译文更新时间：2026-11-07T00:33:18.951Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40assuradeurengilde/fontawesome-iconpicker
原文对照：https://npmcn.com/package/%40assuradeurengilde/fontawesome-iconpicker/?lang=original
项目主页：https://github.com/assuradeuren-gilde/fontawesome-iconpicker/
源码仓库：https://github.com/assuradeuren-gilde/fontawesome-iconpicker

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：410 kB，15 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2022-05-24T08:58:53.956Z
- 最新版本发布：2022-05-24T11:49:28.242Z
- 近 30 天下载量：4092（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

用于 Twitter Botstrap 的字体优美图标拾取器插件

## 安装

```sh
npm install @assuradeurengilde/fontawesome-iconpicker
```

也可以使用：`pnpm add @assuradeurengilde/fontawesome-iconpicker`、`yarn add @assuradeurengilde/fontawesome-iconpicker`、`bun add @assuradeurengilde/fontawesome-iconpicker`

## README

# 字体精致的选取器

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

Font Aweous Icon Picker是一个完全自定义的推特靴子插件, 具有强大的基础 API,基于 [捡花鞋的](https://itsjavi.github.io/bootstrap-popover-picker/)

您可以使用Font Cousin 5 或您选择的另一个字体图标集( icon 列表完全可自定义) .

[查看演示](https://itsjavi.github.io/fontawesome-iconpicker/)

## 证据

您可以以多种方式调用插件 :

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

## 触发事件

他们都通过事件.icon pickerInstance曝光了插件实例

电话顺序:

-   创建图标
-   创建图标
-   图标标出
-   图标标出
-   图标选择( 也显示事件. iconpicker 项目和事件. iconpickerValue)
-   图标拾取器更新日期
-   图标拾取者 Invalid( 也曝光事件. icon拾取者Value)
-   图标拾取器SetValue(同时曝光事件.iconickerValue)
-   图标拾取器Set SourceValue( 也曝光事件. iconickerValue)
-   图标拾取器已更新
-   图标选择( 也显示事件. icon pickers 项目和事件. icon pickersValue)
-   图标拾取器隐藏
-   隐藏图标
-   图标拾取器
-   已销毁

```javascript
// Bind iconpicker events to the element
$('.my').on('iconpickerSelected', function(event){
  /* event.iconpickerValue */
});
```

## 弹出式放置扩展

这个插件的放置选项比最初的"靴子陷阱"要多. 详细情况如下:

```
        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
```

## 可用选项

```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: '<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>',
    }
};
```

## 常见问题

### @assuradeurengilde/fontawesome-iconpicker 是什么？

用于 Twitter Botstrap 的字体优美图标拾取器插件

### 如何安装 @assuradeurengilde/fontawesome-iconpicker？

在项目目录运行 npm install @assuradeurengilde/fontawesome-iconpicker，或使用 pnpm add / yarn add / bun add。

### @assuradeurengilde/fontawesome-iconpicker 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/assuradeurengilde\_\_fontawesome-iconpicker 是否存在。

### @assuradeurengilde/fontawesome-iconpicker 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @assuradeurengilde/fontawesome-iconpicker 可以商用吗？

@assuradeurengilde/fontawesome-iconpicker 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @assuradeurengilde/fontawesome-iconpicker 的下载量有多少？

根据 npm 官方下载统计，@assuradeurengilde/fontawesome-iconpicker 在 2026/10/07 – 2026/11/05 这 30 天内被下载 4,092 次，日均约 136 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @assuradeurengilde/fontawesome-iconpicker 还在维护吗？

最新版本 3\.2\.3 发布于 2022/05/24（4 年前）；至今共发布 4 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/05/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。