/Hashtegny

jQuery Plugin aggregates hashtags from different social media networks. Posts are displayed in a unique, & attractive grid, and animated layout.

Primary LanguageJavaScriptMIT LicenseMIT

Hashtegny

Hashtegny

jQuery Plugin aggregates hashtags from different social media networks. Posts are displayed in a unique, & attractive grid, and animated layout.

You can use it for personal purpose, during any conference or event, for an organization, or even at a Store. So, you can engage the audiences anywhere and increase your interaction and impact.

How to do that? Simply you can use it on your website, mobile, TV displays, or using projectors on a wall.

Social Networks Supported

  • Twitter
  • Instagram
  • Google+
  • VK
  • Facebook(Deprecated)

Demo

Check Demo

Features

  • Aggregates hashtags from different social media networks.
  • Displays the posts in a grid and animated layout.
  • You can define your own template for posts.
  • Works on different screen sizes.
  • It automatically updates the time stamp of each post.
  • It automatically adds recent posts if any.
  • Posts are sorted according to the time they were created at.
  • Posts are clickable.
  • Ready to be used anywhere; conference, event, at a Store.
  • You can use it on your websites, mobile, TV, Using projectors on wall.
  • Build based on latest version of jQuery(CDN)
  • Easy to be maintained and customized.

Install

You can install with npm

npm install hashtegny 

Getting Started

Add CSS Files:

 <!-- Font Awesome -->
 <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css">
 <!-- Main CSS File -->
 <link rel="stylesheet" href="css/hashtegny.css" type="text/css" />
 <!-- Main CSS File(Grid Layout) - Default -->
 <link id="layout-style" rel="stylesheet" href="css/main.grid.css" type="text/css" />

Add JS Files:

 <!-- jQuery -->
 <script type="text/javascript" src="node_modules/jquery/dist/jquery.min.js"></script>
 <!-- Grid Layout -->
 <script type="text/javascript" src="node_modules/masonry-layout/dist/masonry.pkgd.min.js"></script>
 <!-- doT.js Template Engine -->
 <script type="text/javascript" src="node_modules/dot/doT.min.js"></script>
 <!-- Twitter JS library -->
 <script type="text/javascript" src="node_modules/codebird/codebird.js"></script>
 <!-- Animation -->
 <script type="text/javascript" src="js/animations.min.js"></script>
 <script type="text/javascript" src="js/appear.min.js"></script>
 <!-- Hashtegny -->
 <script type="text/javascript" src="js/hashtegny.js"></script>

Finally, Run the plugin:

<!-- Inside your <body> tag -->
<div id="hashtegny-container"></div>
 <script>
        $(document).ready(function(){

            // this line of code because GitHub Pages(or something else weird) changes the link tags to style tags.
            $("style#layout-style").after('<link id="layout-style" rel="stylesheet" href="css/main.grid.css" type="text/css" />').remove(); 
            
            // start the plugin & pass your options
            $('#hashtegny-container').hashtegny({
                twitter:{
                    enable: true,
                    hashtag: "twitter",
                    count: 5        // number of posts to be displayed
                },
                google:{
                    enable: true,
                    hashtag: "google",
                    count: 5
                },
                instagram:{
                    enable: true,
                    hashtag: "insta",
                    count: 5
                },
                vk:{
                    enable: true,
                    hashtag: "зима",
                    count: 5
                },
                textLength: 300,            // max length of post content
                animate: 8,                 // time of animation for each post in seconds
                refresh: 60,                // add recent posts if any evey 60 seconds
                updateTime: 60,             // update post time every 60 second(1 min)
                template: "default.html",   // filename for the post template. The 'template' has a priority over 'template_html' if not assigned to null
                template_html:              // HTML for the post template
                '<div> \
                    <img src="{{=post.attachement_src}}" width="{{=post.attachement_width}}" height="{{=post.attachement_height}}">  \
                    <div> \
                        <img src="{{=post.user_image}}"> \
                        <h4>{{=post.user_name}}</h4> \
                        <div onclick="window.open(\'{{=post.url}}\');"><p>{{=post.text}}</p></div> \
                        <p><i class="fa fa-clock-o"></i><span> {{=post.time}}</span></p> \
                    </div> \
                </div>',        
                callback: function() {          // A callback function which will fire when all the posts are fetched and displayed
                    console.log("Posts have been fetched and displayed");
                },             
                background: false,               // add background image(i.e 'background.jpg'). Images are inside img folder.
                showError: false                 // show error alert box if any error encountered
            });
        });
 </script>

Support

I've written this script in my free time during my studies. This is for free, unpaid. If you find it useful, please support the project by spreading the word.

Contribute

Contribute by creating new issues, sending pull requests on Github or you can send an email at: omar.elgabry.93@gmail.com

Dependencies

License

Built under MIT license.