README

Emoticons-js

A jquery plugin to insert emojis, font smileys, embed videos (youtube/vimeo), media files,pdf and highlight code syntax.

Features

Converts emoticon text codes into emoticons :smile: , :heart:
Finds links in text input and turns them into html links.
Youtube and Vimeo video embedding with video details fetched from the api.
HTML5 player supported media embedding (mp3,mp4,ogg)
PDF viewing with preview and then the actual pdf in a frame.
Inline Code Syntax highlighting (uses highlight.js)
Twitter tweet embedding supported
Codepen, jsbin, jsfiddle embed supported
soundcloud and spotify support
Twitch tv, dotSub, dailymotion, vine,TED and liveLeak support.
Google map location embed

Dependencies

Jquery >= 1.2
Highlight.js (Optional if code syntax highlighting is needed)
Twitter widgets.js (Optional if tweet embed support is set to true needed)

Getting started

Bower

bower install --save emoticons-js

npm

npm install --save emoticons-js

Load css file

<link rel="stylesheet" href="path/to/jquery.emoticons.css"/>

Load Scripts

<script src="path/to/jquery.min.js"></script>
<!--==== Optional =====-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/8.4/highlight.min.js"></script>
<script src="http://platform.twitter.com/widgets.js"></script>
<!--===================-->
<script src="path/to/jquery.emoticons.js"></script>

HTML Structure

<div id="element">
  <div> Some content here </div>
  <div> Some content here </div>
  ...
  ...
</div>

Simple Usage

<script>
$('#element').emoticons({
    gdevAuthKey : 'xxxxxxxx'
});
</script>

Advanced Usage

<script>
$('#element').emoticons({
      //Instructs the library whether or not to embed urls
      link              : true,
      //same as the target attribute in html anchor tag . supports all html supported target values.
      linkTarget        : '_blank',
      //Array of extensions to be excluded from converting into links
      linkExclude       : ['jpg','pdf'],
      //set true to show a preview of pdf links
      pdfEmbed          : true,
      //set true to embed images
      imageEmbed        : true,
      //set true to embed audio
      audioEmbed        : false,
      //set true to show a preview of youtube/vimeo videos with details
      videoEmbed        : true,
      //set true to show basic video files like mp4 etc. (supported by html5 player)
      basicVideoEmbed   : true,
      //width of the video frame (in pixels)
      videoWidth        : 640,
      //height of the video frame (in pixels)
      videoHeight       : 390,
      //( Mandatory ) The authorization key obtained from google's developer console for
      //using youtube data api and map embed api
      gdevAuthKey         : 'xxxxxxx',
      //Set google map location embed
      // Use @(place-name) to use this feature . Eg: @(Sydney)
      locationEmbed       :true,
      //Instructs the library whether or not to highlight code syntax.
      highlightCode     : true,
      //Instructs the library whether or not embed the tweets
      tweetsEmbed     : true,
      tweetOptions:{
            //The maximum width of a rendered Tweet in whole pixels. Must be between 220 and 550 inclusive.
            maxWidth   : 550,
            //When set to true or 1 links in a Tweet are not expanded to photo, video, or link previews.
            hideMedia  : false,
            //When set to true or 1 a collapsed version of the previous Tweet in a conversation thread
            //will not be displayed when the requested Tweet is in reply to another Tweet.
            hideThread : false,
            //Specifies whether the embedded Tweet should be floated left, right, or center in
            //the page relative to the parent element.Valid values are left, right, center, and none.
            //Defaults to none, meaning no alignment styles are specified for the Tweet.
            align      : 'none',
            //Request returned HTML and a rendered Tweet in the specified.
            //Supported Languages listed here (https://dev.twitter.com/web/overview/languages)
            lang       : 'en'
      },
      //set to true to embed codepen
      codepenEmbed      :true,
      //codepen height (width can be adjusted by css)
      codepenHeight     :300,
      //set to true to embed jsfiddle
      jsfiddleEmbed     :true,
      //jsfiddle height (width can be adjusted by css)
      jsfiddleHeight    :300,
      //set to true to embed jsbin
      jsbinEmbed        :true,
      //jsbin height (width can be adjusted by css)
      jsbinHeight       :300,
      //set to true to embed soundcloud
      spotifyEmbed     :true,
      soundCloudEmbed  : true,
      soundCloudOptions: {
          height      : 160,
          themeColor  : 'f50000',    //Hex Code of the player theme color
          autoPlay    : false,
          hideRelated : false,
          showComments: true,
          showUser    : true,        //Show or hide the uploader name, useful e.g. in tiny players to save space)
          showReposts : false,
          visual      : false,       //Show/hide the big preview image
          download    : false        //Show/Hide download buttons
              },
      twitchtvEmbed     :true,
      dotsubEmbed       :true,
      dailymotionEmbed  :true,
      vineEmbed        : true,
      vineOptions:{
            width:500,
            type:'postcard'         //'postcard' or 'simple' embedding
      },
      tedEmbed         :true,
      liveleakEmbed     :true,
      //callback before pdf preview
      beforePdfPreview  : function(){},
      //callback after pdf preview
      afterPdfPreview   : function(){},
      // callback on video frame view
      onVideoShow:function(){},
      //callback on video load (youtube/vimeo)
      onVideoLoad:function(){}

});
</script>

If you specify either one of videoWidth or videoHeight , the other option will be automatically set in the aspected ratio.

Contributing

Before sending a pull request remember to follow jQuery Core Style Guide.

Fork it!
Create your feature branch: git checkout -b my-new-feature
Make your changes on the src folder, never on the dist folder.
Commit your changes: git commit -m 'Add some feature'
Push to the branch: git push origin my-new-feature
Submit a pull request :smile:

License

The MIT License (MIT)
Copyright (c) 2014 Ritesh Kumar

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.

Usage no npm install needed!