Do not presume that jQuery is loaded with the $ global

jQuery can be loaded without the $ global token, to avoid certain problems with other js packages. The $ is an alias for jQuery() and jQuery, respectively, so one can always use on of those instead to make sure the code is portable. This patch makes it possible to use a generated story.js on a website where jquery is already loaded without the global token.
textadventures · Sep 1, 2015 · 3b251b3 · 3b251b3
1 parent dd5ca42
commit 3b251b3
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/index.template.html b/index.template.html
@@ -8,7 +8,7 @@
 		<script src="story.js" charset="UTF-8"></script>
 		<!-- SCRIPTS -->
 		<script>
-			$(function(){
+			jQuery(function($){
 				$('#squiffy').squiffy();
 				var restart = function () {
 					$('#squiffy').squiffy('restart');
@@ -31,4 +31,4 @@
 			</div>
 		</div>
 	</body>
-</html>
+</html>
diff --git a/squiffy.template.js b/squiffy.template.js
@@ -50,12 +50,12 @@ var squiffy = {};
         };
 
         squiffy.ui.output.on('click', 'a.squiffy-link', function () {
-            handleLink($(this));
+            handleLink(jQuery(this));
         });
 
         squiffy.ui.output.on('keypress', 'a.squiffy-link', function (e) {
             if (e.which !== 13) return;
-            handleLink($(this));
+            handleLink(jQuery(this));
         });
 
         squiffy.ui.output.on('mousedown', 'a.squiffy-link', function (event) {
@@ -233,7 +233,7 @@ var squiffy = {};
     squiffy.story.restart = function() {
         if (squiffy.ui.settings.persist && window.localStorage) {
             var keys = Object.keys(localStorage);
-            $.each(keys, function (idx, key) {
+            jQuery.each(keys, function (idx, key) {
                 if (startsWith(key, squiffy.story.id)) {
                     localStorage.removeItem(key);
                 }
@@ -259,7 +259,7 @@ var squiffy = {};
         var output = squiffy.get('_output');
         if (!output) return false;
         squiffy.ui.output.html(output);
-        currentSection = $('#' + squiffy.get('_output-section'));
+        currentSection = jQuery('#' + squiffy.get('_output-section'));
         squiffy.story.section = squiffy.story.sections[squiffy.get('_section')];
         var transition = squiffy.get('_transition');
         if (transition) {
@@ -291,12 +291,12 @@ var squiffy = {};
 
     var newSection = function() {
         if (currentSection) {
-            disableLink($('.squiffy-link', currentSection));
+            disableLink(jQuery('.squiffy-link', currentSection));
         }
         var sectionCount = squiffy.get('_section-count') + 1;
         squiffy.set('_section-count', sectionCount);
         var id = 'squiffy-section-' + sectionCount;
-        currentSection = $('<div/>', {
+        currentSection = jQuery('<div/>', {
             id: id,
         }).appendTo(squiffy.ui.output);
         squiffy.set('_output-section', id);
@@ -305,7 +305,7 @@ var squiffy = {};
     squiffy.ui.write = function(text) {
         screenIsClear = false;
         scrollPosition = squiffy.ui.output.height();
-        currentSection.append($('<div/>').html(squiffy.ui.processText(text)));
+        currentSection.append(jQuery('<div/>').html(squiffy.ui.processText(text)));
         squiffy.ui.scrollToEnd();
     };
 
@@ -328,13 +328,13 @@ var squiffy = {};
         }
         else {
             scrollTo = scrollPosition;
-            currentScrollTop = Math.max($('body').scrollTop(), $('html').scrollTop());
+            currentScrollTop = Math.max(jQuery('body').scrollTop(), jQuery('html').scrollTop());
             if (scrollTo > currentScrollTop) {
-                var maxScrollTop = $(document).height() - $(window).height();
+                var maxScrollTop = jQuery(document).height() - jQuery(window).height();
                 if (scrollTo > maxScrollTop) scrollTo = maxScrollTop;
                 distance = scrollTo - currentScrollTop;
                 duration = distance / 0.5;
-                $('body,html').stop().animate({ scrollTop: scrollTo }, duration);
+                jQuery('body,html').stop().animate({ scrollTop: scrollTo }, duration);
             }
         }
     };
@@ -552,15 +552,15 @@ var squiffy = {};
 
     var methods = {
         init: function (options) {
-            var settings = $.extend({
+            var settings = jQuery.extend({
                 scroll: 'body',
                 persist: true,
                 restartPrompt: true,
                 onSet: function (attribute, value) {}
             }, options);
 
             squiffy.ui.output = this;
-            squiffy.ui.restart = $(settings.restart);
+            squiffy.ui.restart = jQuery(settings.restart);
             squiffy.ui.settings = settings;
 
             if (settings.scroll === 'element') {
@@ -585,15 +585,15 @@ var squiffy = {};
         }
     };
 
-    $.fn.squiffy = function (methodOrOptions) {
+    jQuery.fn.squiffy = function (methodOrOptions) {
         if (methods[methodOrOptions]) {
             return methods[methodOrOptions]
                 .apply(this, Array.prototype.slice.call(arguments, 1));
         }
         else if (typeof methodOrOptions === 'object' || ! methodOrOptions) {
             return methods.init.apply(this, arguments);
         } else {
-            $.error('Method ' +  methodOrOptions + ' does not exist');
+            jQuery.error('Method ' +  methodOrOptions + ' does not exist');
         }
     };
 })();