Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/micc83/fontIconPicker
🌈 jQuery fontIconPicker v2 is a small (3.22kb gzipped) jQuery plugin which allows you to include a simple icon picker with search and pagination inside your administration forms.
https://github.com/micc83/fontIconPicker
font-icons fontello icon-picker jquery-fonticonpicker jquery-plugin
Last synced: about 2 months ago
JSON representation
🌈 jQuery fontIconPicker v2 is a small (3.22kb gzipped) jQuery plugin which allows you to include a simple icon picker with search and pagination inside your administration forms.
- Host: GitHub
- URL: https://github.com/micc83/fontIconPicker
- Owner: micc83
- License: mit
- Created: 2014-02-25T12:19:57.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-09-01T07:27:17.000Z (about 4 years ago)
- Last Synced: 2024-07-18T01:21:40.362Z (2 months ago)
- Topics: font-icons, fontello, icon-picker, jquery-fonticonpicker, jquery-plugin
- Language: HTML
- Homepage: http://micc83.github.io/fontIconPicker/
- Size: 2.34 MB
- Stars: 266
- Watchers: 22
- Forks: 87
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
jQuery fontIconPicker v3.0 is out
==============
Version 2.0 of jQuery fontIconPicker will no more receive updates nor support. You can find **Version 3.0** right here:
[Click here to get jQuery fontIconPicker v3.0](https://github.com/fontIconPicker/fontIconPicker)
jQuery fontIconPicker v2.0
==============
jQuery fontIconPicker is a small (`3.22KB` gzipped) jQuery plugin which allows you to include an elegant icon picker with categories, search and pagination inside your administration forms. The list of icons can be loaded manually using a `SELECT` field, an `Array` or `Object` of icons or directly from a Fontello `config.json` or IcoMoon `selection.json` file. Go to the [official plugin page](http://micc83.github.io/fontIconPicker/) for examples and documentation.
**Notice** : Many of the features introduced with release 2.0.0 were the result of a collaboration. Unfortunately the developer of those features is not actively following the project anymore so you're more than welcome to step in. The problem is that since version 1.0.0 jQuery fontIconPicker has grown much and it's not mantainable anymore without writing first a carefully drafted test suite. So the first stage of any collaboration would be about writing unit and integration testing for everything implemented up to now (I know it's a pain in the ...). **Until then unfortunately It won't be possible to me to address any bug or add new features.** Thx for the understanding.
## How it works
Just include a copy of jQuery, the fontIconPickers script, the fontIconPickers theme and your Font Icons. Now you can trigger it on a `SELECT` or `INPUT[type="text"]` element.
### Include the JavaScript
```html
```
### Include the CSS
```html
```
### Include Font Icons
```html
```
### Initialize with jQuery
Finally call the fontIconPicker on a `SELECT` or `INPUT[type="text"]` element.
```html
No icon
icon-user
icon-search
icon-right-dir
icon-star
icon-cancel
icon-help-circled
icon-info-circled
icon-eye
icon-tag
icon-bookmark
icon-heart
icon-thumbs-down-alt
icon-upload-cloud
icon-phone-squared
icon-cog
icon-wrench
icon-volume-down
icon-down-dir
icon-up-dir
icon-left-dir
icon-thumbs-up-alt
// Make sure to fire only when the DOM is ready
jQuery(document).ready(function($) {
$('#myselect').fontIconPicker(); // Load with default options
});
```
```html
jQuery(document).ready(function($) {
$('#mytext').fontIconPicker({
source: ['icon-heart', 'icon-search', 'icon-user', 'icon-tag', 'icon-help'],
emptyIcon: false,
hasSearch: false
});
});
```
## Plugin Options
Here's fontIconPicker options:
```js
var $picker = $('.picker').fontIconPicker({
theme : 'fip-grey', // The CSS theme to use with this fontIconPicker. You can set different themes on multiple elements on the same page
source : false, // Icons source (array|false|object)
emptyIcon : true, // Empty icon should be shown?
emptyIconValue : '', // The value of the empty icon, change if you select has something else, say "none"
iconsPerPage : 20, // Number of icons per page
hasSearch : true, // Is search enabled?
searchSource : false, // Give a manual search values. If using attributes then for proper search feature we also need to pass icon names under the same order of source
useAttribute : false, // Whether to use attribute selector for printing icons
attributeName : 'data-icon', // HTML Attribute name
convertToHex : true, // Whether or not to convert to hexadecimal for attribute value. If true then please pass decimal integer value to the source (or as value="" attribute of the select field)
allCategoryText : 'From all categories', // The text for the select all category option
unCategorizedText : 'Uncategorized' // The text for the select uncategorized option
});
```
## Plugin APIs
fontIconPicker provides three public APIs to manipulating the icon picker.
### setIcons( `Array|Object` newIcons, `Array|Object` iconSearch )
Use this method to dynamically change icons on the fly. `newIcons` and `iconSearch` (optional) have same datatypes as `source` and `searchSource` options.
```js
$picker.setIcons(['icon-one', 'icon-two']);
$picker.setIcons(['icon-one', 'icon-two'], ['Icon one will be searched by this', 'Icon two will be searched by this']);
```
### destroyPicker()
Use this to remove the icon picker and restore the original element.
```js
$picker.destroyPicker();
```
### refreshPicker( `Object|Boolean` newOptions )
Refresh the icon picker from DOM or passed options. Useful when DOM has been changed or reinitializing after calling the destroy method or changing the options values.
```js
$picker.refreshPicker({
theme: 'fip-bootstrap',
hasSearch: false
});
```
Options and APIs are discussed in details with live examples at the project page.
### Important notes for local demo
Only when loading demo locally: In firefox fontIconPicker icons won't be shown correctly because of CORS. For the same reason "Load icons from Fontello JSON config file" won't work on Chrome or IE 10. If you need to do some local testing you can disable strict_origin_policy at your risk.
## Browser Compatibility
jQuery iconPicker has been successfully tested on: Firefox (edge), Safari (edge), Chrome (edge), IE8+ and Opera (edge).
## Credits
jQuery fontIconPicker has been made by [me](https://github.com/micc83) & [swashata](https://github.com/swashata). You can contact me at [email protected] or [twitter](https://twitter.com/Micc1983) for any issue or feauture request.
I really have to thank miniMAC for the idea, Zeno Rocha for jQuery plugin boilerplate, Dave Gandy & KeyaMoon for the beautiful sets of icons and Elliot Condon for the amazing Advanced Custom Field WordPress plugin.