Skip to content

Latest commit

 

History

History
157 lines (118 loc) · 5.31 KB

README.md

File metadata and controls

157 lines (118 loc) · 5.31 KB
Raw

#minEmoji Collection

The smallest JavaScript/CSS libraries and jQuery Plug-ins to replace all new Emojis into CSS Sprite images using <span> element, Apple, Google/Android, Emoji One and Twitter Sprites included.

emojis

jMinEmoji2 Demo
minEmoji_iOS8 Demo
jMinEmoji-SVG Demo Some SVGs are not available.
jMinEmoji Demo
minEmoji Demo

###Special Notes:

  1. jMinEmoji-SVG doesn't have all assets available on the latest iOS / OS X release, but Emoji One devs will release a new version soon.
  2. Missing emojis on unfinished sprites are replaced with Apple emojis.
  3. If you use TweetDeck.com and want all new emojis, use this fork I made from Better TweetDeck which uses minEmoji in order to replace and input emojis.

###jMinEmoji2 jQuery plugin: iOS 9.1 ready, a simple solution using PNG Sprites, usage: Include the CSS and JS into your HTML and apply the minEmoji() function to any jQuery selector.

<link href="css/minEmoji2.css" rel="stylesheet">
<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="js/jMinEmoji2.js"></script>
<script>
	$(function(){
		$('.txt').minEmoji();
	});	
</script>

iOS and Apple Devices: jMinEmoji doesn't replace Emoji on Safari, but you can force that behavior passing true to the function:

$(function(){
	$('.txt').minEmoji(true);
});

###jMinEmoji-SVG jQuery plugin:

The jMinEmoji-SVG jQuery plugin is the perfect solutions for HiDPI displays, low bandwidth consumption; 127 bytes on CSS, 17.41KiB (not using gzip) on JavaScript, loading emojis on demand from very small numerically named SVG files.

Usage: Include the CSS and JS into your HTML and apply the minEmojiSVG() function to any jQuery selector.

<link href="css/jMinEmoji-SVG.css" rel="stylesheet">
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="js/jMinEmoji-SVG.min.js"></script>
<script>
	$(function(){
		$('.txt').minEmojiSVG();
	});	
</script>

iOS and Apple Devices: jMinEmoji-SVG doesn't replace Emoji on Safari, but you can force that behavior with the safari: true option:

$(function(){
	$('.txt').minEmojiSVG({ 
		safari:		false, 		// Force emoji replacement on Safari
		svg_path:	'img/svg/'	// Set the SVG image path
	});
});

###jMinEmoji jQuery plugin: A simple solution using PNG Sprites, usage: Include the CSS and JS into your HTML and apply the minEmoji() function to any jQuery selector.

<link href="css/minEmoji.css" rel="stylesheet">
<script src="http://code.jquery.com/jquery-1.11.0.min.js"></script>
<script src="js/jMinEmoji.js"></script>
<script>
	$(function(){
		$('.txt').minEmoji();
	});	
</script>

iOS and Apple Devices: jMinEmoji doesn't replace Emoji on Safari, but you can force that behavior passing true to the function:

$(function(){
	$('.txt').minEmoji(true);
});

###minEmoji: For those who like to code without jQuery, usage: Include the CSS and JS into your HTML document and call the function minEmoji(string) to replace a desired text.

<link href="css/minEmoji.css" rel="stylesheet">
<script src="js/minEmoji.js"></script>
<script>
	$('#div').html(minEmoji(string));	
</script>

###Why another library?

Here is a post with the huge emoji image source files and full explanation: http://rodrigopolo.com/codigo/minemoji-another-emoji-js-library.html

License

(The MIT License)

Copyright (c) by Rodrigo Polo http://RodrigoPolo.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###Emoji One assets License Attribution required, use one of the following:

###Twitter Emoji assets License Copyright 2014 Twitter, Inc and other contributors Graphics licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/