jquery.tour.js 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527
  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="icon-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 = '';
  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="icon-check-sign"></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="icon-remove-sign"></i></div>';
  150. }
  151. var _link = '<a href="javascript:$.jHueTour(\'' + tour.name + '\', 1)" style="padding-left:0">';
  152. if (typeof tour.video != "undefined" && tour.video != null && tour.video != ""){
  153. _extraIcon = '<i class="icon-youtube-play"></i> ';
  154. }
  155. else if (typeof tour.blog != "undefined" && tour.blog != null && tour.blog != ""){
  156. _extraIcon = '<i class="icon-external-link"></i> ';
  157. _link = '<a href="' + tour.blog + '" target="_blank" style="padding:0">';
  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 (_added > 0 && typeof $.totalStorage !== "undefined" && ($.totalStorage("jHueTourHideModal") == null || $.totalStorage("jHueTourHideModal") == false)) {
  172. $(document).ready(function () {
  173. $("#jHueTourModal").modal();
  174. $.totalStorage("jHueTourHideModal", true);
  175. $("#jHueTourModalChk").attr("checked", "checked");
  176. $("#jHueTourModalChk").on("change", function () {
  177. $.totalStorage("jHueTourHideModal", $(this).is(":checked"));
  178. });
  179. });
  180. }
  181. if (_this.options.showRemote){
  182. _toursHtml += '<li>' +
  183. ' <div class="input-append" style="margin-top: 10px">' +
  184. ' <input id="jHueTourRemoteTutorial" style="width:70%" type="text" placeholder="URL">' +
  185. ' <button id="jHueTourRemoteTutorialBtn" class="btn" type="button" onclick="javascript:$.jHueTour($(\'#jHueTourRemoteTutorial\').val())">' +
  186. ' <i class="icon-cloud-download"></i></button>' +
  187. ' </div>' +
  188. '</li>';
  189. }
  190. _toursHtml += '</ul>';
  191. _questionMark.click(function () {
  192. var _closeBtn = $("<a>");
  193. _closeBtn.html('<i class="icon-remove"></i>').addClass("btn-mini").css("cursor", "pointer").css("margin-left", "7px").css("float", "right").css("margin-top", "-4px").css("margin-right", "-6px");
  194. _closeBtn.click(function () {
  195. $(".popover").remove();
  196. });
  197. _questionMark.popover("destroy").popover({
  198. title: _this.options.labels.AVAILABLE_TOURS,
  199. content: _toursHtml,
  200. html: true,
  201. trigger: "manual",
  202. placement: "left"
  203. }).popover("show");
  204. if ($(".popover").position().top <= 0) {
  205. $(".popover").css("top", "10px");
  206. }
  207. _closeBtn.prependTo($(".popover-title"));
  208. });
  209. _questionMark.appendTo($("#jHueTourFlagPlaceholder"));
  210. };
  211. Plugin.prototype.addTours = function (options) {
  212. var _this = this;
  213. var _addableTours = [];
  214. if (options.tours != null) {
  215. $.each(options.tours, function (cnt, tour) {
  216. var _add = true;
  217. if (_this.options.tours != null) {
  218. $.each(_this.options.tours, function (icnt, itour) {
  219. if (itour.name == tour.name) {
  220. _add = false;
  221. }
  222. });
  223. }
  224. if (_add) {
  225. _addableTours.push(tour);
  226. }
  227. });
  228. }
  229. _this.options.tours = _this.options.tours.concat(_addableTours);
  230. };
  231. Plugin.prototype.availableTours = function () {
  232. return this.options.tours;
  233. };
  234. Plugin.prototype.performOperation = function (operation) {
  235. var _this = this;
  236. var _op = operation.toLowerCase();
  237. if (_op.indexOf("http:") == 0) {
  238. $("#jHueTourRemoteTutorial").attr("disabled", "disabled");
  239. $("#jHueTourRemoteTutorialBtn").attr("disabled", "disabled");
  240. $.ajax({
  241. type: "GET",
  242. url: operation + "?callback=?",
  243. async: false,
  244. jsonpCallback: "jHueRemoteTour",
  245. contentType: "application/json",
  246. dataType: "jsonp",
  247. success: function (json) {
  248. if ($.totalStorage !== undefined) {
  249. if ($.totalStorage("jHueTourExtras") == null) {
  250. $.totalStorage("jHueTourExtras", []);
  251. }
  252. var _newStoredArray = [];
  253. if (json.tours != null) {
  254. _newStoredArray = json.tours;
  255. $.each($.totalStorage("jHueTourExtras"), function (cnt, tour) {
  256. var _found = false;
  257. $.each(json.tours, function (icnt, itour) {
  258. if (itour.name == tour.name) {
  259. _found = true;
  260. }
  261. });
  262. if (!_found) {
  263. _newStoredArray.push(tour);
  264. }
  265. });
  266. }
  267. $.totalStorage("jHueTourExtras", _newStoredArray);
  268. }
  269. $("#jHueTourFlag").popover("destroy");
  270. _this.initQuestionMark();
  271. $("#jHueTourFlag").click();
  272. },
  273. error: function (e) {
  274. $(document).trigger("error", e.message);
  275. $("#jHueTourRemoteTutorial").removeAttr("disabled");
  276. $("#jHueTourRemoteTutorialBtn").removeAttr("disabled");
  277. }
  278. });
  279. }
  280. if (_op.indexOf("remove_") == 0) {
  281. var _tourName = _op.substr(7);
  282. if ($.totalStorage !== undefined) {
  283. var _newStoredArray = [];
  284. $.each($.totalStorage("jHueTourExtras"), function (cnt, tour) {
  285. if (tour.name != _tourName) {
  286. _newStoredArray.push(tour);
  287. }
  288. });
  289. $.totalStorage("jHueTourExtras", _newStoredArray);
  290. $("#jHueTourFlag").popover("destroy");
  291. _this.initQuestionMark();
  292. $("#jHueTourFlag").click();
  293. }
  294. }
  295. if (_op == "start" || _op == "show" || _op == "play") {
  296. if (_this.options.tours.length > 0 && _this.currentTour.name == "") {
  297. _this.currentTour.name = _this.options.tours[0].name;
  298. _this.currentTour.path = _this.options.tours[0].path;
  299. _this.currentTour.steps = _this.options.tours[0].steps;
  300. _this.currentTour.desc = _this.options.tours[0].desc;
  301. _this.currentTour.video = _this.options.tours[0].video;
  302. _this.currentTour.blog = _this.options.tours[0].blog;
  303. }
  304. this.showStep(1);
  305. }
  306. if (_op == "reset") {
  307. if ($.totalStorage !== undefined) {
  308. $.totalStorage("jHueTourHistory", null);
  309. $.totalStorage("jHueTourExtras", null);
  310. }
  311. }
  312. if (_op == "clear") {
  313. _this.options.tours = [];
  314. }
  315. if (_op == "end" || _op == "hide" || _op == "close" || _op == "stop") {
  316. _this.closeCurtains();
  317. }
  318. };
  319. Plugin.prototype.closeCurtains = function () {
  320. $(".popover").remove();
  321. $(".jHueTourExposed").removeClass("jHueTourExposed");
  322. $("#jHueTourMask").hide();
  323. };
  324. Plugin.prototype.showTour = function (tourName, stepNo) {
  325. var _this = this;
  326. if (_this.options.tours != null) {
  327. $.each(_this.options.tours, function (cnt, tour) {
  328. if (tour.name == tourName && (tour.path === undefined || RegExp(tour.path).test(location.pathname))) {
  329. _this.currentTour.name = tour.name;
  330. _this.currentTour.path = tour.path;
  331. _this.currentTour.steps = tour.steps;
  332. _this.currentTour.desc = tour.desc;
  333. _this.currentTour.video = tour.video;
  334. _this.currentTour.blog = tour.blog;
  335. if (stepNo === undefined) {
  336. _this.showStep(1);
  337. }
  338. else {
  339. _this.showStep(stepNo);
  340. }
  341. return;
  342. }
  343. });
  344. }
  345. };
  346. Plugin.prototype.showStep = function (stepNo) {
  347. var _this = this;
  348. if (typeof _this.currentTour.video != "undefined" && _this.currentTour.video != null && _this.currentTour.video != "") {
  349. if ($("#jHueTourVideoPlayer").length == 0) {
  350. var _playerHTML = '<div class="modal-header">' +
  351. '<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>' +
  352. '<h3>' + _this.currentTour.desc + '</h3>' +
  353. '</div>' +
  354. '<div class="modal-body">' +
  355. '<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">' +
  356. (typeof _this.currentTour.blog != "undefined" && _this.currentTour.blog != "" ? '<br/><a href="' + _this.currentTour.blog + '" target="_blank"><i class="icon-external-link"></i> ' + _this.options.labels.MORE_INFO + '</a>' : '') +
  357. '</div></div>';
  358. var _player = $("<div>").attr("id", "jHueTourVideoPlayer").addClass("modal").addClass("hide").addClass("fade");
  359. _player.html(_playerHTML);
  360. _player.appendTo($("body"));
  361. }
  362. else {
  363. $("#jHueTourVideoPlayer").find("h3").html(_this.currentTour.desc);
  364. $("#jHueTourVideoPlayer").find(".moreInfo").html(typeof _this.currentTour.blog != "undefined" && _this.currentTour.blog != "" ? '<a href="' + _this.currentTour.blog + '" target="_blank"><i class="icon-external-link"></i> ' + _this.options.labels.MORE_INFO + '</a>' : '');
  365. $("#jHueTourVideoFrame").attr("src", _this.currentTour.video + "?autoplay=1");
  366. }
  367. $("#jHueTourVideoPlayer").modal().modal("show");
  368. $("#jHueTourVideoPlayer").on("hidden", function () {
  369. $("#jHueTourVideoFrame").attr("src", "about:blank");
  370. });
  371. }
  372. else {
  373. if (_this.currentTour.steps[stepNo - 1] != null) {
  374. var _step = _this.currentTour.steps[stepNo - 1];
  375. _this.currentTour.shownStep = stepNo;
  376. var _navigation = "";
  377. if (_step.visitUrl != undefined) {
  378. location.href = _step.visitUrl;
  379. }
  380. if (_step.onShown != undefined) {
  381. window.setTimeout(_step.onShown, 10);
  382. }
  383. $(".popover").remove();
  384. $(".jHueTourExposed").removeClass("jHueTourExposed");
  385. if ($(".jHueTourExposed").css("position") == "relative") {
  386. $(".jHueTourExposed").css("position", "relative");
  387. }
  388. $("#jHueTourMask").width($(document).width()).height($(document).height()).show();
  389. var _closeBtn = $("<a>");
  390. _closeBtn.addClass("btn").addClass("btn-mini").html('<i class="icon-remove"></i>').css("float", "right").css("margin-top", "-4px").css("margin-right", "-6px");
  391. _closeBtn.click(function () {
  392. _this.performOperation("close");
  393. });
  394. var _nextBtn = $("<a>");
  395. _nextBtn.addClass("btn").addClass("btn-mini").html('<i class="icon-chevron-sign-right"></i>').css("margin-top", "10px");
  396. _nextBtn.click(function () {
  397. _this.showStep(_this.currentTour.shownStep + 1);
  398. });
  399. var _prevBtn = $("<a>");
  400. _prevBtn.addClass("btn").addClass("btn-mini").html('<i class="icon-chevron-sign-left"></i>').css("margin-top", "10px").css("margin-right", "10px");
  401. _prevBtn.click(function () {
  402. _this.showStep(_this.currentTour.shownStep - 1);
  403. });
  404. var _arrowOn = _step.arrowOn;
  405. var _additionalContent = "";
  406. if ($(_arrowOn).length == 0 || !($(_arrowOn).is(":visible"))) {
  407. _arrowOn = "body";
  408. _additionalContent = "<b>MISSING POINTER OF STEP " + _this.currentTour.shownStep + "</b> ";
  409. }
  410. $(_arrowOn).popover('destroy').popover({
  411. title: _step.title,
  412. content: _additionalContent + _step.content + "<br/>",
  413. html: true,
  414. trigger: 'manual',
  415. placement: (_step.placement != "" && _step.placement != undefined) ? _step.placement : "left"
  416. }).popover('show');
  417. if (_step.top != undefined) {
  418. if ($.isNumeric(_step.top)) {
  419. $(".popover").css("top", ($(".popover").position().top + _step.top) + "px");
  420. }
  421. else {
  422. $(".popover").css("top", _step.top);
  423. }
  424. }
  425. if (_step.left != undefined) {
  426. if ($.isNumeric(_step.left)) {
  427. $(".popover").css("left", ($(".popover").position().left + _step.left) + "px");
  428. }
  429. else {
  430. $(".popover").css("left", _step.left);
  431. }
  432. }
  433. $(".popover-title").html(_step.title);
  434. _closeBtn.prependTo($(".popover-title"));
  435. if (_this.currentTour.shownStep > 1) {
  436. _prevBtn.appendTo($(".popover-content p"));
  437. }
  438. if (_this.currentTour.shownStep < _this.currentTour.steps.length && (_step.waitForAction == undefined || _step.waitForAction == false)) {
  439. _nextBtn.appendTo($(".popover-content p"));
  440. }
  441. // last step, mark tour/tutorial as done
  442. if ($.totalStorage !== undefined && _this.currentTour.shownStep == _this.currentTour.steps.length) {
  443. var _key = location.pathname;
  444. if (_this.currentTour.path !== undefined && _this.currentTour.path != "") {
  445. _key = _this.currentTour.path;
  446. }
  447. _key += "_" + _this.currentTour.name;
  448. var _history = $.totalStorage("jHueTourHistory");
  449. if (_history == null) {
  450. _history = {}
  451. }
  452. _history[_key] = true;
  453. $.totalStorage("jHueTourHistory", _history);
  454. }
  455. var _exposedElement = $((_step.expose != undefined && _step.expose != "" ? _step.expose : _arrowOn));
  456. if (_exposedElement.css("position") === undefined || _exposedElement.css("position") != "fixed") {
  457. _exposedElement.css("position", "relative");
  458. }
  459. _exposedElement.addClass("jHueTourExposed");
  460. }
  461. }
  462. };
  463. $[pluginName] = function (options, stepNo) {
  464. var _el = $("body");
  465. if (!$("body").data('plugin_' + pluginName)) {
  466. $("body").data('plugin_' + pluginName, new Plugin(_el, options));
  467. }
  468. if (options === undefined) {
  469. return $("body").data('plugin_' + pluginName).availableTours();
  470. }
  471. if (typeof options == "string") {
  472. if (stepNo === undefined) {
  473. $("body").data('plugin_' + pluginName).performOperation(options);
  474. }
  475. else if ($.isNumeric(stepNo)) {
  476. $("body").data('plugin_' + pluginName).showTour(options, stepNo);
  477. }
  478. }
  479. else if ($.isNumeric(options)) {
  480. $("body").data('plugin_' + pluginName).showStep(options);
  481. }
  482. else {
  483. $("body").data('plugin_' + pluginName).addTours(options);
  484. }
  485. };
  486. })(jQuery, window, document);