jquery.tour.js 21 KB

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