jquery.tour.js 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531
  1. // Licensed to Cloudera, Inc. under one
  2. // or more contributor license agreements. See the NOTICE file
  3. // distributed with this work for additional information
  4. // regarding copyright ownership. Cloudera, Inc. licenses this file
  5. // to you under the Apache License, Version 2.0 (the
  6. // "License"); you may not use this file except in compliance
  7. // with the License. You may obtain a copy of the License at
  8. //
  9. // http://www.apache.org/licenses/LICENSE-2.0
  10. //
  11. // Unless required by applicable law or agreed to in writing, software
  12. // distributed under the License is distributed on an "AS IS" BASIS,
  13. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. // See the License for the specific language governing permissions and
  15. // limitations under the License.
  16. /*
  17. * jHue tour plugin
  18. * Optionally depends on $.totalstorage for progress checking and $.jHueNotify for error notification
  19. * Can be instantiated with
  20. $.jHueTour({
  21. tours: [ <-- array, the tours available for this page
  22. {
  23. name: "xxxx", <-- unique tour name (location.pathname scope)
  24. desc: "Desc yyyy", <-- the label shown on the question mark
  25. path: "beeswax/*", <-- string for the path to show this tour on
  26. steps: [ <-- array, steps of the tour
  27. {
  28. arrowOn: "a[href='/beeswax']", <-- the element relative to the popover is positioned
  29. expose: ".navbar-fixed-top", <-- optional, the exposed object. if not present, arrowOn will be exposed
  30. title: "Welcome to Beeswax!", <-- popover title
  31. content: "This is a tour of the Beeswax app. <br/><b>HTML</b> is supported <em>too!</em>", <-- popover content, html enable
  32. placement: "bottom", <-- popover placement
  33. left: "100px", <-- popover absolute position (css string)
  34. top: -20 <-- popover relative position (it adds that amount of pixels to the popover calculated position)
  35. visitUrl: "blabla?tour=hello" <-- overrides everything, redirects to specific url
  36. },
  37. {
  38. arrowOn: ".subnav-fixed",
  39. title: "Beeswax sections",
  40. content: "There are several sections in the Beeswax app",
  41. placement: "bottom",
  42. left: "100px"
  43. }, ...
  44. ],
  45. video: "http://player.vimeo.com/xxxxx", <-- instead of the steps you can specify a video and it will be displayed in a modal
  46. blog: "http://gethue.tumblr.com/yyyyy" <-- if specified, a link to this with a "Read more about it..." label will be placed under the video in the modal. if video is empty, the link will be automagically opened
  47. }, ...
  48. ]
  49. });
  50. Calling $.jHueTour({tours: [...]}) more than once will merge the tour data, so you can keep adding tours dynamically to the same page
  51. You can interact with:
  52. - $.jHueTour("start") / $.jHueTour("show") / $.jHueTour("play") : starts the first available tour
  53. - $.jHueTour("stop") / $.jHueTour("close") / $.jHueTour("hide") / $.jHueTour("stop") : starts the first available tour
  54. - $.jHueTour("reset") : removes stored tours and history
  55. - $.jHueTour("clear") : removes current tours
  56. - $.jHueTour("http://remote/hue/tour.hue") : loads a remote tour
  57. - $.jHueTour("tourName", 1) : loads tour name and start at step 1
  58. - $.jHueTour() : returns the available tours
  59. */
  60. (function ($, window, document, undefined) {
  61. var pluginName = "jHueTour",
  62. defaults = {
  63. labels: {
  64. AVAILABLE_TOURS: "Available tours",
  65. NO_AVAILABLE_TOURS: "None for this page",
  66. MORE_INFO: "Read more about it...",
  67. TOOLTIP_TITLE: "Demo tutorials"
  68. },
  69. tours: [],
  70. showRemote: false,
  71. hideIfNoneAvailable: true
  72. };
  73. function Plugin(element, options) {
  74. this.element = element;
  75. if (typeof jHueTourGlobals !== undefined) {
  76. var extendedDefaults = $.extend({}, defaults, jHueTourGlobals);
  77. extendedDefaults.labels = $.extend({}, defaults.labels, jHueTourGlobals.labels);
  78. this.options = $.extend({}, extendedDefaults, options);
  79. this.options = $.extend({}, defaults, this.options);
  80. }
  81. else {
  82. this.options = $.extend({}, defaults, options);
  83. }
  84. this._defaults = defaults;
  85. this._name = pluginName;
  86. this.currentTour = {
  87. name: "",
  88. path: "",
  89. desc: "",
  90. remote: false,
  91. steps: [],
  92. shownStep: 0,
  93. video: "",
  94. blog: ""
  95. };
  96. this.init();
  97. }
  98. Plugin.prototype.init = function () {
  99. var _this = this;
  100. _this.initQuestionMark();
  101. var _tourMask = $("<div>").attr("id", "jHueTourMask");
  102. _tourMask.width($(document).width()).height($(document).height())
  103. _tourMask.click(function () {
  104. _this.closeCurtains();
  105. });
  106. _tourMask.appendTo($("body"));
  107. $(document).on("keyup", function (e) {
  108. var _code = (e.keyCode ? e.keyCode : e.which);
  109. if ($("#jHueTourMask").is(":visible") && _code == 27) {
  110. _this.performOperation("close");
  111. }
  112. });
  113. };
  114. Plugin.prototype.initQuestionMark = function () {
  115. var _this = this;
  116. $("#jHueTourFlag").remove();
  117. var _questionMark = $("<a>").attr("id", "jHueTourFlag").html('<i class="fa fa-flag-checkered" style=""></i>');
  118. _questionMark.tooltip({
  119. placement: "bottom",
  120. title: _this.options.labels.TOOLTIP_TITLE
  121. });
  122. if ($.totalStorage("jHueTourExtras") != null) {
  123. var _newTours = [];
  124. $.each(_this.options.tours, function (cnt, tour) {
  125. if (tour.remote == undefined || !tour.remote) {
  126. _newTours.push(tour);
  127. }
  128. });
  129. _this.options.tours = _newTours.concat($.totalStorage("jHueTourExtras"));
  130. }
  131. var _toursHtml = '<ul class="nav nav-pills nav-stacked" style="margin-bottom: 0">'
  132. var _added = 0;
  133. $.each(_this.options.tours, function (ctn, tour) {
  134. if (tour.path === undefined || RegExp(tour.path).test(location.pathname)) {
  135. var _tourDone = '';
  136. var _removeTour = '';
  137. var _extraIcon = '<i class="fa fa-flag"></i> ';
  138. if ($.totalStorage !== undefined) {
  139. var _key = location.pathname;
  140. if (tour.path !== undefined && tour.path != "") {
  141. _key = tour.path;
  142. }
  143. _key += "_" + tour.name;
  144. if ($.totalStorage("jHueTourHistory") != null && $.totalStorage("jHueTourHistory")[_key] == true) {
  145. _tourDone = '<div style="color:green;float:right;margin:4px"><i class="fa fa-check-circle"></i></div>';
  146. }
  147. }
  148. if (tour.remote) {
  149. _removeTour = '<div style="color:red;float:right;margin:4px;cursor: pointer" onclick="javascript:$.jHueTour(\'remove_' + tour.name + '\')"><i class="fa fa-times-circle"></i></div>';
  150. }
  151. var _link = '<a href="javascript:$.jHueTour(\'' + tour.name + '\', 1)" style="padding:2px">';
  152. if (typeof tour.video != "undefined" && tour.video != null && tour.video != ""){
  153. _extraIcon = '<i class="fa fa-youtube-play"></i> ';
  154. }
  155. else if (typeof tour.blog != "undefined" && tour.blog != null && tour.blog != ""){
  156. _extraIcon = '<i class="fa fa-external-link"></i> ';
  157. _link = '<a href="' + tour.blog + '" target="_blank" style="padding:2px">';
  158. }
  159. _toursHtml += '<li>' + _removeTour + _tourDone + _link + _extraIcon + tour.desc + '</a></li>';
  160. _added++;
  161. }
  162. });
  163. if (_added == 0) {
  164. if (_this.options.hideIfNoneAvailable){
  165. _questionMark.css("display", "none");
  166. }
  167. else {
  168. _toursHtml += '<li>' + _this.options.labels.NO_AVAILABLE_TOURS + '</li>';
  169. }
  170. }
  171. if (_this.options.showRemote){
  172. _toursHtml += '<li>' +
  173. ' <div class="input-append" style="margin-top: 10px">' +
  174. ' <input id="jHueTourRemoteTutorial" style="width:70%" type="text" placeholder="URL">' +
  175. ' <button id="jHueTourRemoteTutorialBtn" class="btn" type="button" onclick="javascript:$.jHueTour($(\'#jHueTourRemoteTutorial\').val())">' +
  176. ' <i class="fa fa-cloud-download"></i></button>' +
  177. ' </div>' +
  178. '</li>';
  179. }
  180. _toursHtml += '</ul>';
  181. _questionMark.click(function () {
  182. var _closeBtn = $("<a>");
  183. _closeBtn.html('<i class="fa fa-times"></i>').css("cursor", "pointer").css("padding", "5px").css("padding-left", "17px").css("padding-right", "7px").css("float", "right").css("margin-top", "-4px").css("margin-right", "-6px");
  184. _closeBtn.click(function () {
  185. $(".popover").remove();
  186. $(document).off("keyup");
  187. $(document).off("click");
  188. });
  189. _questionMark.popover("destroy").popover({
  190. title: _this.options.labels.AVAILABLE_TOURS,
  191. content: _toursHtml,
  192. html: true,
  193. trigger: "click",
  194. placement: "bottomRight"
  195. }).popover("show");
  196. if ($(".popover").position().top <= 0) {
  197. $(".popover").css("top", "10px");
  198. }
  199. _closeBtn.prependTo($(".popover-title"));
  200. $(document).on("keyup", function (e) {
  201. if (e.keyCode == 27) {
  202. _closeBtn.click();
  203. }
  204. });
  205. $(document).on("click", function (e) {
  206. if ($(e.target).parents('.popover').length == 0 && !($(e.target).hasClass("fa-flag-checkered"))) {
  207. _closeBtn.click();
  208. }
  209. });
  210. });
  211. _questionMark.appendTo($("#jHueTourFlagPlaceholder"));
  212. };
  213. Plugin.prototype.addTours = function (options) {
  214. var _this = this;
  215. var _addableTours = [];
  216. if (options.tours != null) {
  217. $.each(options.tours, function (cnt, tour) {
  218. var _add = true;
  219. if (_this.options.tours != null) {
  220. $.each(_this.options.tours, function (icnt, itour) {
  221. if (itour.name == tour.name) {
  222. _add = false;
  223. }
  224. });
  225. }
  226. if (_add) {
  227. _addableTours.push(tour);
  228. }
  229. });
  230. }
  231. _this.options.tours = _this.options.tours.concat(_addableTours);
  232. };
  233. Plugin.prototype.availableTours = function () {
  234. return this.options.tours;
  235. };
  236. Plugin.prototype.performOperation = function (operation) {
  237. var _this = this;
  238. var _op = operation.toLowerCase();
  239. if (_op.indexOf("http:") == 0) {
  240. $("#jHueTourRemoteTutorial").attr("disabled", "disabled");
  241. $("#jHueTourRemoteTutorialBtn").attr("disabled", "disabled");
  242. $.ajax({
  243. type: "GET",
  244. url: operation + "?callback=?",
  245. async: false,
  246. jsonpCallback: "jHueRemoteTour",
  247. contentType: "application/json",
  248. dataType: "jsonp",
  249. success: function (json) {
  250. if ($.totalStorage !== undefined) {
  251. if ($.totalStorage("jHueTourExtras") == null) {
  252. $.totalStorage("jHueTourExtras", []);
  253. }
  254. var _newStoredArray = [];
  255. if (json.tours != null) {
  256. _newStoredArray = json.tours;
  257. $.each($.totalStorage("jHueTourExtras"), function (cnt, tour) {
  258. var _found = false;
  259. $.each(json.tours, function (icnt, itour) {
  260. if (itour.name == tour.name) {
  261. _found = true;
  262. }
  263. });
  264. if (!_found) {
  265. _newStoredArray.push(tour);
  266. }
  267. });
  268. }
  269. $.totalStorage("jHueTourExtras", _newStoredArray);
  270. }
  271. $("#jHueTourFlag").popover("destroy");
  272. _this.initQuestionMark();
  273. $("#jHueTourFlag").click();
  274. },
  275. error: function (e) {
  276. $(document).trigger("error", e.message);
  277. $("#jHueTourRemoteTutorial").removeAttr("disabled");
  278. $("#jHueTourRemoteTutorialBtn").removeAttr("disabled");
  279. }
  280. });
  281. }
  282. if (_op.indexOf("remove_") == 0) {
  283. var _tourName = _op.substr(7);
  284. if ($.totalStorage !== undefined) {
  285. var _newStoredArray = [];
  286. $.each($.totalStorage("jHueTourExtras"), function (cnt, tour) {
  287. if (tour.name != _tourName) {
  288. _newStoredArray.push(tour);
  289. }
  290. });
  291. $.totalStorage("jHueTourExtras", _newStoredArray);
  292. $("#jHueTourFlag").popover("destroy");
  293. _this.initQuestionMark();
  294. $("#jHueTourFlag").click();
  295. }
  296. }
  297. if (_op == "start" || _op == "show" || _op == "play") {
  298. if (_this.options.tours.length > 0 && _this.currentTour.name == "") {
  299. _this.currentTour.name = _this.options.tours[0].name;
  300. _this.currentTour.path = _this.options.tours[0].path;
  301. _this.currentTour.steps = _this.options.tours[0].steps;
  302. _this.currentTour.desc = _this.options.tours[0].desc;
  303. _this.currentTour.video = _this.options.tours[0].video;
  304. _this.currentTour.blog = _this.options.tours[0].blog;
  305. }
  306. this.showStep(1);
  307. }
  308. if (_op == "reset") {
  309. if ($.totalStorage !== undefined) {
  310. $.totalStorage("jHueTourHistory", null);
  311. $.totalStorage("jHueTourExtras", null);
  312. }
  313. }
  314. if (_op == "clear") {
  315. _this.options.tours = [];
  316. }
  317. if (_op == "end" || _op == "hide" || _op == "close" || _op == "stop") {
  318. _this.closeCurtains();
  319. }
  320. };
  321. Plugin.prototype.closeCurtains = function () {
  322. $(".popover").remove();
  323. $(".jHueTourExposed").removeClass("jHueTourExposed");
  324. $("#jHueTourMask").hide();
  325. };
  326. Plugin.prototype.showTour = function (tourName, stepNo) {
  327. var _this = this;
  328. if (_this.options.tours != null) {
  329. $.each(_this.options.tours, function (cnt, tour) {
  330. if (tour.name == tourName && (tour.path === undefined || RegExp(tour.path).test(location.pathname))) {
  331. _this.currentTour.name = tour.name;
  332. _this.currentTour.path = tour.path;
  333. _this.currentTour.steps = tour.steps;
  334. _this.currentTour.desc = tour.desc;
  335. _this.currentTour.video = tour.video;
  336. _this.currentTour.blog = tour.blog;
  337. if (stepNo === undefined) {
  338. _this.showStep(1);
  339. }
  340. else {
  341. _this.showStep(stepNo);
  342. }
  343. return;
  344. }
  345. });
  346. }
  347. };
  348. Plugin.prototype.showStep = function (stepNo) {
  349. var _this = this;
  350. if (typeof _this.currentTour.video != "undefined" && _this.currentTour.video != null && _this.currentTour.video != "") {
  351. if ($("#jHueTourVideoPlayer").length == 0) {
  352. var _playerHTML = '<div class="modal-header">' +
  353. '<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>' +
  354. '<h3>' + _this.currentTour.desc + '</h3>' +
  355. '</div>' +
  356. '<div class="modal-body">' +
  357. '<iframe id="jHueTourVideoFrame" src="' + _this.currentTour.video + '?autoplay=1" width="700" height="350" frameborder="0" webkitallowfullscreen="" mozallowfullscreen="" allowfullscreen="" style="height:360px;width:640px"></iframe><div class="moreInfo">' +
  358. (typeof _this.currentTour.blog != "undefined" && _this.currentTour.blog != "" ? '<br/><a href="' + _this.currentTour.blog + '" target="_blank"><i class="fa fa-external-link"></i> ' + _this.options.labels.MORE_INFO + '</a>' : '') +
  359. '</div></div>';
  360. var _player = $("<div>").attr("id", "jHueTourVideoPlayer").addClass("modal").addClass("hide").addClass("fade");
  361. _player.html(_playerHTML);
  362. _player.appendTo($("body"));
  363. }
  364. else {
  365. $("#jHueTourVideoPlayer").find("h3").html(_this.currentTour.desc);
  366. $("#jHueTourVideoPlayer").find(".moreInfo").html(typeof _this.currentTour.blog != "undefined" && _this.currentTour.blog != "" ? '<a href="' + _this.currentTour.blog + '" target="_blank"><i class="fa fa-external-link"></i> ' + _this.options.labels.MORE_INFO + '</a>' : '');
  367. $("#jHueTourVideoFrame").attr("src", _this.currentTour.video + "?autoplay=1");
  368. }
  369. $("#jHueTourVideoPlayer").modal().modal("show");
  370. $("#jHueTourVideoPlayer").on("hidden", function () {
  371. $("#jHueTourVideoFrame").attr("src", "about:blank");
  372. });
  373. }
  374. else {
  375. if (_this.currentTour.steps[stepNo - 1] != null) {
  376. var _step = _this.currentTour.steps[stepNo - 1];
  377. _this.currentTour.shownStep = stepNo;
  378. var _navigation = "";
  379. if (_step.visitUrl != undefined) {
  380. location.href = _step.visitUrl;
  381. }
  382. if (_step.onShown != undefined) {
  383. window.setTimeout(_step.onShown, 10);
  384. }
  385. $(".popover").remove();
  386. $(".jHueTourExposed").removeClass("jHueTourExposed");
  387. if ($(".jHueTourExposed").css("position") == "relative") {
  388. $(".jHueTourExposed").css("position", "relative");
  389. }
  390. $("#jHueTourMask").width($(document).width()).height($(document).height()).show();
  391. var _closeBtn = $("<a>");
  392. _closeBtn.addClass("btn").addClass("btn-mini").html('<i class="fa fa-times"></i>').css("float", "right").css("margin-top", "-4px").css("margin-right", "-6px");
  393. _closeBtn.click(function () {
  394. _this.performOperation("close");
  395. });
  396. var _nextBtn = $("<a>");
  397. _nextBtn.addClass("btn").addClass("btn-mini").html('<i class="fa fa-chevron-circle-right"></i>').css("margin-top", "10px");
  398. _nextBtn.click(function () {
  399. _this.showStep(_this.currentTour.shownStep + 1);
  400. });
  401. var _prevBtn = $("<a>");
  402. _prevBtn.addClass("btn").addClass("btn-mini").html('<i class="fa fa-chevron-circle-left"></i>').css("margin-top", "10px").css("margin-right", "10px");
  403. _prevBtn.click(function () {
  404. _this.showStep(_this.currentTour.shownStep - 1);
  405. });
  406. var _arrowOn = _step.arrowOn;
  407. var _additionalContent = "";
  408. if ($(_arrowOn).length == 0 || !($(_arrowOn).is(":visible"))) {
  409. _arrowOn = "body";
  410. _additionalContent = "<b>MISSING POINTER OF STEP " + _this.currentTour.shownStep + "</b> ";
  411. }
  412. $(_arrowOn).popover('destroy').popover({
  413. title: _step.title,
  414. content: _additionalContent + _step.content + "<br/>",
  415. html: true,
  416. trigger: 'manual',
  417. placement: (_step.placement != "" && _step.placement != undefined) ? _step.placement : "left"
  418. }).popover('show');
  419. if (_step.top != undefined) {
  420. if ($.isNumeric(_step.top)) {
  421. $(".popover").css("top", ($(".popover").position().top + _step.top) + "px");
  422. }
  423. else {
  424. $(".popover").css("top", _step.top);
  425. }
  426. }
  427. if (_step.left != undefined) {
  428. if ($.isNumeric(_step.left)) {
  429. $(".popover").css("left", ($(".popover").position().left + _step.left) + "px");
  430. }
  431. else {
  432. $(".popover").css("left", _step.left);
  433. }
  434. }
  435. $(".popover-title").html(_step.title);
  436. _closeBtn.prependTo($(".popover-title"));
  437. if (_this.currentTour.shownStep > 1) {
  438. _prevBtn.appendTo($(".popover-content p"));
  439. }
  440. if (_this.currentTour.shownStep < _this.currentTour.steps.length && (_step.waitForAction == undefined || _step.waitForAction == false)) {
  441. _nextBtn.appendTo($(".popover-content p"));
  442. }
  443. // last step, mark tour/tutorial as done
  444. if ($.totalStorage !== undefined && _this.currentTour.shownStep == _this.currentTour.steps.length) {
  445. var _key = location.pathname;
  446. if (_this.currentTour.path !== undefined && _this.currentTour.path != "") {
  447. _key = _this.currentTour.path;
  448. }
  449. _key += "_" + _this.currentTour.name;
  450. var _history = $.totalStorage("jHueTourHistory");
  451. if (_history == null) {
  452. _history = {}
  453. }
  454. _history[_key] = true;
  455. $.totalStorage("jHueTourHistory", _history);
  456. }
  457. var _exposedElement = $((_step.expose != undefined && _step.expose != "" ? _step.expose : _arrowOn));
  458. if (_exposedElement.css("position") === undefined || _exposedElement.css("position") != "fixed") {
  459. _exposedElement.css("position", "relative");
  460. }
  461. _exposedElement.addClass("jHueTourExposed");
  462. }
  463. }
  464. };
  465. $[pluginName] = function (options, stepNo) {
  466. var _el = $("body");
  467. if (!$("body").data('plugin_' + pluginName)) {
  468. $("body").data('plugin_' + pluginName, new Plugin(_el, options));
  469. }
  470. if (options === undefined) {
  471. return $("body").data('plugin_' + pluginName).availableTours();
  472. }
  473. if (typeof options == "string") {
  474. if (stepNo === undefined) {
  475. $("body").data('plugin_' + pluginName).performOperation(options);
  476. }
  477. else if ($.isNumeric(stepNo)) {
  478. $("body").data('plugin_' + pluginName).showTour(options, stepNo);
  479. }
  480. }
  481. else if ($.isNumeric(options)) {
  482. $("body").data('plugin_' + pluginName).showStep(options);
  483. }
  484. else {
  485. $("body").data('plugin_' + pluginName).addTours(options);
  486. }
  487. };
  488. })(jQuery, window, document);