Mattflaschen has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/376854 )
Change subject: Add documentation for 'autoFocus' and 'width'
......................................................................
Add documentation for 'autoFocus' and 'width'
Change-Id: I7b3b4d0bfb0304a2e57355738fd88385ce40b589
---
M modules/ext.guidedTour.lib/ext.guidedTour.lib.TourBuilder.js
1 file changed, 7 insertions(+), 0 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/GuidedTour
refs/changes/54/376854/1
diff --git a/modules/ext.guidedTour.lib/ext.guidedTour.lib.TourBuilder.js
b/modules/ext.guidedTour.lib/ext.guidedTour.lib.TourBuilder.js
index cb157a4..eab25f1 100644
--- a/modules/ext.guidedTour.lib/ext.guidedTour.lib.TourBuilder.js
+++ b/modules/ext.guidedTour.lib/ext.guidedTour.lib.TourBuilder.js
@@ -99,6 +99,8 @@
* format as position. The values within the structure can also be
selectors or
* jQuery-wrapped nodes.
*
+ * @param {Number} [stepSpec.width=400] Width, in pixels.
+ *
* @param {Function} [stepSpec.onShow] Function to execute immediately
* before the guider is shown. Using this for gt.parseDescription or
* gt.getPageAsDescription is deprecated. However, a string value of
description
@@ -119,6 +121,11 @@
*
* To suppress this, set allowAutomaticNext to false for the step.
*
+ * @param {boolean} [stepSpec.autoFocus=true] By default, the browser
will scroll
+ * to make the guider visible.
+ *
+ * To avoid this, set autoFocus to false for the step.
+ *
* @param {boolean} [stepSpec.closeOnClickOutside=true] Close the
* guider when the user clicks elsewhere on screen
*
--
To view, visit https://gerrit.wikimedia.org/r/376854
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I7b3b4d0bfb0304a2e57355738fd88385ce40b589
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/GuidedTour
Gerrit-Branch: master
Gerrit-Owner: Mattflaschen <mflasc...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
