@kunalnagarco/jquery-peek-a-bar 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Kunal Nagar
+
+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.

package/README.md

@@ -0,0 +1,161 @@
+# @kunalnagarco/jquery-peek-a-bar
+
+<!-- [![npm version](https://img.shields.io/npm/v/jquery-peek-a-bar.svg)](https://www.npmjs.com/package/jquery-peek-a-bar) -->
+
+A jQuery plugin for a notification bar with customization options.
+
+## Installation
+
+```bash
+npm install @kunalnagarco/jquery-peek-a-bar --save
+```
+
+## Options
+
+### html
+
+Use custom HTML as bar text.
+
+Type: `String`
+Default: `Your Message Here`
+
+### autohide
+
+Autohide the bar after it is shown.
+
+Type: `Boolean`
+Default: `false`
+
+### delay
+
+Time (in ms) before the bar is hidden if `autohide` is `true`.
+
+Type: `Number`
+Default: `3000`
+
+### padding
+
+Add some padding to the bar.
+
+Type: `String`
+Default: `1em`
+
+### backgroundColor
+
+Add a custom background color to the bar.
+
+Type: `String`
+Default: `rgb(195, 195, 195)`
+
+### animation
+
+The way in which the bar reveals itself.
+
+Type: `Object`
+Example:
+
+```
+animation: {
+    type: 'slide/fade',
+    duration: 'slow/3000(in ms)'
+}
+```
+
+### cssClass
+
+Assign a Custom CSS class to the bar.
+
+Type: `String`
+Default: `empty`
+
+### opacity
+
+Change bar opacity.
+
+Type: `Number`
+Default: `1`
+
+### position
+
+Where should the bar be revealed? Top or bottom of the page?
+
+Type: `String`
+Default: `top`
+Values: `top | bottom`
+
+### closeOnClick
+
+Close the bar by clicking on it.
+
+Type: `Boolean`
+Default: `false`
+
+## Event Methods
+
+### onShow
+
+Called after the bar is shown.
+
+### onHide
+
+Called after the bar is hidden.
+
+## Instance Methods
+
+### bar.show()
+
+Show the bar.
+
+### bar.hide()
+
+Hide the bar.
+
+## Example
+
+Please check out the complete example below:
+
+```
+// Create a bar
+var bar = $.peekABar({
+    html: 'Custom Message',
+    delay: 2000,
+    autohide: true,
+    padding: '2em',
+    backgroundColor: 'rgb(195, 195, 195)',
+    animation: {
+        type: 'fade',
+        duration: '2000'
+    },
+    opacity: '0.8',
+    cssClass: 'custom-class',
+    position: 'bottom',
+    closeOnClick: true
+    onShow: function() {
+        console.log('called after bar is shown');
+    },
+    onHide: function() {
+        console.log('called after bar is hidden');
+    }
+});
+
+// Show the bar
+bar.show();
+
+// Hide the bar
+bar.hide();
+
+// Show the bar with custom HTML
+// This call will override the HTML
+// set in any previous definitions.
+bar.show({
+    html: 'Overrides all, puny human.'
+});
+```
+
+## Support
+
+For any issues/queries, please open a new [Github Issue](https://github.com/kunalnagarco/jquery.peekABar/issues).
+
+## Share
+
+If you like the plugin, please share it with your friends!

package/dist/css/jquery.peekabar.css

@@ -0,0 +1,7 @@
+.peek-a-bar {
+  margin: 0;
+  position: fixed;
+  width: 100%;
+  left: 0;
+  right: 0;
+  text-align: center; }

package/dist/css/jquery.peekabar.min.css

@@ -0,0 +1,2 @@
+.peek-a-bar{margin:0;position:fixed;width:100%;left:0;right:0;text-align:center}
+/*# sourceMappingURL=jquery.peekabar.min.css.map */

package/dist/css/jquery.peekabar.min.css.map

@@ -0,0 +1 @@
+{"version":3,"sources":["dist/css/jquery.peekabar.css"],"names":[],"mappings":"AAAA,YACE,OAAQ,EACR,SAAU,MACV,MAAO,KACP,KAAM,EACN,MAAO,EACP,WAAY"}

package/dist/js/jquery.peekabar.js

@@ -0,0 +1,133 @@
+"use strict";
+
+/**
+ * @license
+ * @kunalnagarco/jquery-peek-a-bar <https://kunalnagarco.github.io/jquery.peekABar>
+ * Copyright 2019 Kunal Nagar
+ * Available under MIT license
+ */
+(function ($) {
+  'use strict';
+
+  $.peekABar = function (options) {
+    var _this = this;
+    var that = this,
+      rand = parseInt(Math.random() * 100000000, 0);
+    this.bar = {};
+    this.settings = {};
+    var defaults = {
+      html: 'Your Message Here',
+      delay: 3000,
+      autohide: false,
+      padding: '1em',
+      backgroundColor: 'rgb(195, 195, 195)',
+      animation: {
+        type: 'slide',
+        duration: 'slow'
+      },
+      cssClass: null,
+      opacity: '1',
+      position: 'top',
+      closeOnClick: false,
+      onShow: function onShow() {},
+      onHide: function onHide() {}
+    };
+    var init = function init() {
+      that.settings = $.extend({}, defaults, options);
+      _create();
+      _applyCustomSettings();
+    };
+    this.show = function (args) {
+      if (args !== undefined) {
+        if (args.html) {
+          _this.bar.html(args.html);
+        }
+      }
+      switch (_this.settings.animation.type) {
+        case 'slide':
+          _this.bar.slideDown(that.settings.animation.duration);
+          break;
+        case 'fade':
+          _this.bar.fadeIn(that.settings.animation.duration);
+          break;
+      }
+      if (_this.settings.autohide) {
+        setTimeout(function () {
+          that.hide();
+        }, _this.settings.delay);
+      }
+      _this.settings.onShow.call(_this, args);
+    };
+    this.hide = function () {
+      switch (_this.settings.animation.type) {
+        case 'slide':
+          _this.bar.slideUp(that.settings.animation.duration);
+          break;
+        case 'fade':
+          _this.bar.fadeOut(that.settings.animation.duration);
+          break;
+      }
+      _this.settings.onHide.call(_this);
+    };
+    var _create = function _create() {
+      that.bar = $('<div></div>').addClass('peek-a-bar').attr('id', '__peek_a_bar_' + rand);
+      $('html').append(that.bar);
+      that.bar.hide();
+    };
+    var _applyCustomSettings = function _applyCustomSettings() {
+      _applyHTML();
+      _applyAutohide();
+      _applyPadding();
+      _applyBackgroundColor();
+      _applyOpacity();
+      _applyCSSClass();
+      _applyPosition();
+      _applyCloseOnClick();
+    };
+    var _applyHTML = function _applyHTML() {
+      that.bar.html(that.settings.html);
+    };
+    var _applyAutohide = function _applyAutohide() {
+      if (that.settings.autohide) {
+        setTimeout(function () {
+          that.hide();
+        }, that.settings.delay);
+      }
+    };
+    var _applyPadding = function _applyPadding() {
+      that.bar.css('padding', that.settings.padding);
+    };
+    var _applyBackgroundColor = function _applyBackgroundColor() {
+      that.bar.css('background-color', that.settings.backgroundColor);
+    };
+    var _applyCSSClass = function _applyCSSClass() {
+      if (that.settings.cssClass !== null) {
+        that.bar.addClass(that.settings.cssClass);
+      }
+    };
+    var _applyOpacity = function _applyOpacity() {
+      that.bar.css('opacity', that.settings.opacity);
+    };
+    var _applyPosition = function _applyPosition() {
+      switch (that.settings.position) {
+        case 'top':
+          that.bar.css('top', 0);
+          break;
+        case 'bottom':
+          that.bar.css('bottom', 0);
+          break;
+        default:
+          that.bar.css('top', 0);
+      }
+    };
+    var _applyCloseOnClick = function _applyCloseOnClick() {
+      if (that.settings.closeOnClick) {
+        that.bar.click(function () {
+          that.hide();
+        });
+      }
+    };
+    init();
+    return this;
+  };
+})(jQuery);

package/dist/js/jquery.peekabar.min.js

@@ -0,0 +1,2 @@
+"use strict";!function(f){f.peekABar=function(t){var s=this,i=this,n=parseInt(1e8*Math.random(),0),a=(this.bar={},{html:"Your Message Here",delay:3e3,autohide:!(this.settings={}),padding:"1em",backgroundColor:"rgb(195, 195, 195)",animation:{type:"slide",duration:"slow"},cssClass:null,opacity:"1",position:"top",closeOnClick:!1,onShow:function(){},onHide:function(){}}),e=(this.show=function(t){switch(void 0!==t&&t.html&&s.bar.html(t.html),s.settings.animation.type){case"slide":s.bar.slideDown(i.settings.animation.duration);break;case"fade":s.bar.fadeIn(i.settings.animation.duration)}s.settings.autohide&&setTimeout(function(){i.hide()},s.settings.delay),s.settings.onShow.call(s,t)},this.hide=function(){switch(s.settings.animation.type){case"slide":s.bar.slideUp(i.settings.animation.duration);break;case"fade":s.bar.fadeOut(i.settings.animation.duration)}s.settings.onHide.call(s)},function(){i.bar=f("<div></div>").addClass("peek-a-bar").attr("id","__peek_a_bar_"+n),f("html").append(i.bar),i.bar.hide()}),o=function(){c(),d(),r(),u(),b(),l(),g(),h()},c=function(){i.bar.html(i.settings.html)},d=function(){i.settings.autohide&&setTimeout(function(){i.hide()},i.settings.delay)},r=function(){i.bar.css("padding",i.settings.padding)},u=function(){i.bar.css("background-color",i.settings.backgroundColor)},l=function(){null!==i.settings.cssClass&&i.bar.addClass(i.settings.cssClass)},b=function(){i.bar.css("opacity",i.settings.opacity)},g=function(){switch(i.settings.position){case"top":i.bar.css("top",0);break;case"bottom":i.bar.css("bottom",0);break;default:i.bar.css("top",0)}},h=function(){i.settings.closeOnClick&&i.bar.click(function(){i.hide()})};return i.settings=f.extend({},a,t),e(),o(),this}}(jQuery);
+//# sourceMappingURL=jquery.peekabar.min.js.map

package/dist/js/jquery.peekabar.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jquery.peekabar.min.js","sources":["jquery.peekabar.js"],"names":["$","peekABar","options","_this","this","that","rand","parseInt","Math","random","defaults","bar","html","delay","autohide","settings","padding","backgroundColor","animation","type","duration","cssClass","opacity","position","closeOnClick","onShow","onHide","_create","show","args","undefined","slideDown","fadeIn","setTimeout","hide","call","slideUp","fadeOut","addClass","attr","append","_applyCustomSettings","_applyHTML","_applyAutohide","_applyPadding","_applyBackgroundColor","_applyOpacity","_applyCSSClass","_applyPosition","_applyCloseOnClick","css","click","extend","jQuery"],"mappings":"AAAA,aAQA,CAAA,SAAWA,GAGTA,EAAEC,SAAW,SAAUC,GACrB,IAAIC,EAAQC,KACRC,EAAOD,KACTE,EAAOC,SAAyB,IAAhBC,KAAKC,OAAO,EAAe,CAAC,EAG1CC,GAFJN,KAAKO,IAAM,GAEI,CACbC,KAAM,oBACNC,MAAO,IACPC,SAAU,EAJZV,KAAKW,SAAW,IAKdC,QAAS,MACTC,gBAAiB,qBACjBC,UAAW,CACTC,KAAM,QACNC,SAAU,MACZ,EACAC,SAAU,KACVC,QAAS,IACTC,SAAU,MACVC,aAAc,CAAA,EACdC,OAAQ,aACRC,OAAQ,YACV,GAsCIC,GAhCJvB,KAAKwB,KAAO,SAAUC,GAMpB,OALaC,KAAAA,IAATD,GACEA,EAAKjB,MACPT,EAAMQ,IAAIC,KAAKiB,EAAKjB,IAAI,EAGpBT,EAAMY,SAASG,UAAUC,MAC/B,IAAK,QACHhB,EAAMQ,IAAIoB,UAAU1B,EAAKU,SAASG,UAAUE,QAAQ,EACpD,MACF,IAAK,OACHjB,EAAMQ,IAAIqB,OAAO3B,EAAKU,SAASG,UAAUE,QAAQ,CAErD,CACIjB,EAAMY,SAASD,UACjBmB,WAAW,WACT5B,EAAK6B,KAAK,CACZ,EAAG/B,EAAMY,SAASF,KAAK,EAEzBV,EAAMY,SAASU,OAAOU,KAAKhC,EAAO0B,CAAI,CACxC,EACAzB,KAAK8B,KAAO,WACV,OAAQ/B,EAAMY,SAASG,UAAUC,MAC/B,IAAK,QACHhB,EAAMQ,IAAIyB,QAAQ/B,EAAKU,SAASG,UAAUE,QAAQ,EAClD,MACF,IAAK,OACHjB,EAAMQ,IAAI0B,QAAQhC,EAAKU,SAASG,UAAUE,QAAQ,CAEtD,CACAjB,EAAMY,SAASW,OAAOS,KAAKhC,CAAK,CAClC,EACc,WACZE,EAAKM,IAAMX,EAAE,aAAa,EAAEsC,SAAS,YAAY,EAAEC,KAAK,KAAM,gBAAkBjC,CAAI,EACpFN,EAAE,MAAM,EAAEwC,OAAOnC,EAAKM,GAAG,EACzBN,EAAKM,IAAIuB,KAAK,CAChB,GACIO,EAAuB,WACzBC,EAAW,EACXC,EAAe,EACfC,EAAc,EACdC,EAAsB,EACtBC,EAAc,EACdC,EAAe,EACfC,EAAe,EACfC,EAAmB,CACrB,EACIP,EAAa,WACfrC,EAAKM,IAAIC,KAAKP,EAAKU,SAASH,IAAI,CAClC,EACI+B,EAAiB,WACftC,EAAKU,SAASD,UAChBmB,WAAW,WACT5B,EAAK6B,KAAK,CACZ,EAAG7B,EAAKU,SAASF,KAAK,CAE1B,EACI+B,EAAgB,WAClBvC,EAAKM,IAAIuC,IAAI,UAAW7C,EAAKU,SAASC,OAAO,CAC/C,EACI6B,EAAwB,WAC1BxC,EAAKM,IAAIuC,IAAI,mBAAoB7C,EAAKU,SAASE,eAAe,CAChE,EACI8B,EAAiB,WACY,OAA3B1C,EAAKU,SAASM,UAChBhB,EAAKM,IAAI2B,SAASjC,EAAKU,SAASM,QAAQ,CAE5C,EACIyB,EAAgB,WAClBzC,EAAKM,IAAIuC,IAAI,UAAW7C,EAAKU,SAASO,OAAO,CAC/C,EACI0B,EAAiB,WACnB,OAAQ3C,EAAKU,SAASQ,UACpB,IAAK,MACHlB,EAAKM,IAAIuC,IAAI,MAAO,CAAC,EACrB,MACF,IAAK,SACH7C,EAAKM,IAAIuC,IAAI,SAAU,CAAC,EACxB,MACF,QACE7C,EAAKM,IAAIuC,IAAI,MAAO,CAAC,CACzB,CACF,EACID,EAAqB,WACnB5C,EAAKU,SAASS,cAChBnB,EAAKM,IAAIwC,MAAM,WACb9C,EAAK6B,KAAK,CACZ,CAAC,CAEL,EAEA,OA/FE7B,EAAKU,SAAWf,EAAEoD,OAAO,GAAI1C,EAAUR,CAAO,EAC9CyB,EAAQ,EACRc,EAAqB,EA6FhBrC,IACT,CACD,EAAEiD,MAAM"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@kunalnagarco/jquery-peek-a-bar",
+  "version": "4.0.0",
+  "description": "A jQuery plugin for a notification bar with a lot of customization options.",
+  "main": "dist/js/jquery.peekabar.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prebuild": "rm -rf build",
+    "build": "grunt build",
+    "release": "semantic-release"
+  },
+  "author": "Kunal Nagar <knlnagar@gmail.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "7.24.7",
+    "@babel/preset-env": "7.24.7",
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/commit-analyzer": "13.0.0",
+    "@semantic-release/git": "10.0.1",
+    "@semantic-release/github": "10.0.6",
+    "@semantic-release/npm": "12.0.1",
+    "@semantic-release/release-notes-generator": "14.0.1",
+    "conventional-changelog-conventionalcommits": "8.0.0",
+    "grunt": "1.6.1",
+    "grunt-babel": "8.0.0",
+    "grunt-contrib-copy": "1.0.0",
+    "grunt-contrib-cssmin": "5.0.0",
+    "grunt-contrib-uglify": "5.2.2",
+    "grunt-contrib-watch": "1.1.0",
+    "grunt-sass": "*",
+    "load-grunt-tasks": "5.1.0",
+    "node-sass": "9.0.0",
+    "prettier": "3.2.5",
+    "semantic-release": "24.0.0",
+    "time-grunt": "2.0.0"
+  },
+  "keywords": [
+    "jquery-plugin",
+    "ecosystem:jquery"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kunalnagarco/jquery.peekABar.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}