add mobileViewDistance to readme #2513

hakimel · Dec 9, 2019 · 94de806 · 94de806
1 parent 1515ddc
commit 94de806
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -382,6 +382,11 @@ Reveal.initialize({
 	// Number of slides away from the current that are visible
 	viewDistance: 3,
 
+	// Number of slides away from the current that are visible on mobile
+	// devices. It is advisable to set this to a lower number than
+	// viewDistance in order to save resources.
+	mobileViewDistance: 2,
+
 	// Parallax background image
 	parallaxBackgroundImage: '', // e.g. "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
 

diff --git a/js/reveal.js b/js/reveal.js
@@ -270,8 +270,9 @@
 			// Number of slides away from the current that are visible
 			viewDistance: 3,
 
-			// Number of slides away from the current that are visible on mobile devices
-			// It is advisable to set this to a lower number than viewDistance in order to save resources
+			// Number of slides away from the current that are visible on mobile
+			// devices. It is advisable to set this to a lower number than
+			// viewDistance in order to save resources.
 			mobileViewDistance: 2,
 
 			// The display mode that will be used to show slides
@@ -3288,7 +3289,8 @@
 			// be visible
 			var viewDistance = isOverview() ? 10 : config.viewDistance;
 
-			// Limit view distance on weaker devices
+			// Shorten the view distance on devices that typically have
+			// less resources
 			if( isMobileDevice ) {
 				viewDistance = isOverview() ? 6 : config.mobileViewDistance;
 			}