Bmansurov has uploaded a new change for review.
https://gerrit.wikimedia.org/r/177880
Change subject: Document defaults in Views
......................................................................
Document defaults in Views
Change-Id: Ide52d0ab1fe7edd3c1aabf3f6d01ef60bad648a7
---
M javascripts/CtaDrawer.js
M javascripts/Icon.js
M javascripts/Overlay.js
M javascripts/Page.js
M javascripts/Section.js
M javascripts/modules/PageList.js
M javascripts/modules/bannerImage/BannerImage.js
M javascripts/modules/categories/CategoryOverlay.js
M javascripts/modules/editor/AbuseFilterOverlay.js
M javascripts/modules/editor/AbuseFilterPanel.js
M javascripts/modules/editor/EditorOverlay.js
M javascripts/modules/editor/EditorOverlayBase.js
M javascripts/modules/infobox/Infobox.js
M javascripts/modules/issues/CleanupOverlay.js
M javascripts/modules/languages/LanguageOverlay.js
M javascripts/modules/mediaViewer/ImageOverlay.js
M javascripts/modules/nearby/Nearby.js
M javascripts/modules/notifications/NotificationsOverlay.js
M javascripts/modules/references/ReferencesDrawer.js
M javascripts/modules/references/ReferencesDrawerBeta.js
M javascripts/modules/search/SearchOverlay.js
M javascripts/modules/talk/TalkOverlay.js
M javascripts/modules/talk/TalkSectionAddOverlay.js
M javascripts/modules/talk/TalkSectionOverlay.js
M javascripts/modules/toc/TableOfContents.js
M javascripts/modules/tutorials/PageActionOverlay.js
M javascripts/modules/uploads/LeadPhotoUploaderButton.js
M javascripts/modules/uploads/PhotoUploadOverlay.js
M javascripts/modules/uploads/PhotoUploadProgress.js
M javascripts/modules/uploads/UploadTutorial.js
M javascripts/modules/watchstar/Watchstar.js
M javascripts/modules/wikigrok/WikiGrokDialog.js
M javascripts/modules/wikigrok/WikiGrokMoreInfo.js
M javascripts/specials/uploads/PhotoList.js
34 files changed, 269 insertions(+), 10 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend
refs/changes/80/177880/1
diff --git a/javascripts/CtaDrawer.js b/javascripts/CtaDrawer.js
index 5c4952a..be47ed2 100644
--- a/javascripts/CtaDrawer.js
+++ b/javascripts/CtaDrawer.js
@@ -11,6 +11,12 @@
* @extends Drawer
*/
CtaDrawer = Drawer.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.collapse HTML of the button that
dismisses the CtaDrawer.
+ * @cfg {String} defaults.login Caption for the login button.
+ * @cfg {String} defaults.signup Caption fr the signup button.
+ */
defaults: {
collapseButton: new Icon( {
name: 'arrow-down',
diff --git a/javascripts/Icon.js b/javascripts/Icon.js
index 57ed4ce..67f7790 100644
--- a/javascripts/Icon.js
+++ b/javascripts/Icon.js
@@ -10,6 +10,17 @@
* @extends View
*/
Icon = View.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {Boolean} defaults.hasText Whether the icon has text.
+ * @cfg {String} defaults.tagName The name of the tag in which
the icon is wrapped.
+ * @cfg {String} defaults.base String used as a base for
generating class names.
+ * Can either be 'mw-ui-icon' (alpha) or 'icon' (stable and
beta).
+ * @cfg {String} defaults.name Name of the icon.
+ * @cfg {String} defaults.modifier Additional class name. Can
either be
+ * 'mw-ui-icon-element' (alpha) or '' (stable and beta).
+ * @cfg {String} defaults.title Title text.
+ */
defaults: {
hasText: false,
tagName: 'div',
diff --git a/javascripts/Overlay.js b/javascripts/Overlay.js
index 9ef7f7b..46d4fb6 100644
--- a/javascripts/Overlay.js
+++ b/javascripts/Overlay.js
@@ -46,6 +46,15 @@
header: mw.template.get( 'mobile.overlays',
'header.hogan' )
},
template: mw.template.get( 'mobile.overlays', 'Overlay.hogan' ),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.saveMessage Caption for save button
on edit form.
+ * @cfg {String} defaults.cancelButton HTML of the cancel
button.
+ * @cfg {String} defaults.backButton HTML of the back button.
+ * @cfg {String} defaults.headerButtonsListClassName FIXME:
document
+ * @cfg {Boolean} defaults.fixedHeader Whether the header is
fixed.
+ * @cfg {String} defaults.spinner HTML of the spinner icon.
+ */
defaults: {
saveMsg: mw.msg( 'mobile-frontend-editor-save' ),
cancelButton: new Icon( {
diff --git a/javascripts/Page.js b/javascripts/Page.js
index 82daa63..6baea87 100644
--- a/javascripts/Page.js
+++ b/javascripts/Page.js
@@ -13,14 +13,21 @@
* @extends View
*/
Page = View.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {Integer} defaults.id Page ID. The default value of 0
represents a new page.
+ * Be sure to override it to avoid side effects.
+ * @cfg {String} defaults.title Title of the page. It includes
prefix where needed and
+ * is human readable, e.g. Talk:The man who lived.
+ * @cfg {String} defaults.displayTitle Title of the page that's
displayed. Falls back
+ * to defaults.title if no value is provided.
+ * @cfg {Object} defaults.protection Page protections. FIXME:
add details
+ * @cfg {Array} defaults.sections Page sections. FIXME: add
details
+ * @cfg {Boolean} defaults.isMainPage Whether the page is the
Main Page.
+ * @cfg {Boolean} defaults.userCanUpload Whether the user can
upload.
+ */
defaults: {
- // id defaults to 0 which represents a new page. Be
sure to override to avoid side effects.
id: 0,
- /**
- * Includes prefix where needed and is human readable.
- * e.g. Talk:The man who lived
- * @type {string}
- */
title: '',
displayTitle: '',
protection: {
diff --git a/javascripts/Section.js b/javascripts/Section.js
index 0d94534..f5eab09 100644
--- a/javascripts/Section.js
+++ b/javascripts/Section.js
@@ -11,6 +11,12 @@
*/
Section = View.extend( {
template: mw.template.get( 'mobile.startup', 'Section.hogan' ),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {?} defaults.line FIXME: add details
+ * @cfg {String} defaults.text Section text.
+ * @cfg {String} defaults.spinner HTML of the spinner icon.
+ */
defaults: {
line: undefined,
text: '',
diff --git a/javascripts/modules/PageList.js b/javascripts/modules/PageList.js
index 09c9274..a226731 100644
--- a/javascripts/modules/PageList.js
+++ b/javascripts/modules/PageList.js
@@ -16,6 +16,11 @@
* @extends View
*/
PageList = View.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {Array} defaults.pages List of {Page} objects. FIXME:
is it?
+ * @cfg {Boolean} defaults.enhance Whether to enhance views
already in DOM. FIXME: clarify
+ */
defaults: {
pages: [],
enhance: false
diff --git a/javascripts/modules/bannerImage/BannerImage.js
b/javascripts/modules/bannerImage/BannerImage.js
index 754481e..ac5fa5b 100644
--- a/javascripts/modules/bannerImage/BannerImage.js
+++ b/javascripts/modules/bannerImage/BannerImage.js
@@ -39,6 +39,10 @@
*/
BannerImage = View.extend( {
className: 'wikidata-banner-image',
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.spinner HTML of the spinner icon.
+ */
defaults: {
spinner: icons.spinner().toHtmlString()
},
diff --git a/javascripts/modules/categories/CategoryOverlay.js
b/javascripts/modules/categories/CategoryOverlay.js
index 3ab05ab..314a903 100644
--- a/javascripts/modules/categories/CategoryOverlay.js
+++ b/javascripts/modules/categories/CategoryOverlay.js
@@ -9,6 +9,13 @@
* @extends Overlay
*/
CategoryOverlay = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.heading Title of the list of
categories this page is
+ * categorized in.
+ * @cfg {String} defaults.subheading Introduction text for the
list of categories,
+ * the page belongs to.
+ */
defaults: {
heading: mw.msg( 'mobile-frontend-categories-heading' ),
subheading: mw.msg(
'mobile-frontend-categories-subheading' )
diff --git a/javascripts/modules/editor/AbuseFilterOverlay.js
b/javascripts/modules/editor/AbuseFilterOverlay.js
index dc747a3..827c22c 100644
--- a/javascripts/modules/editor/AbuseFilterOverlay.js
+++ b/javascripts/modules/editor/AbuseFilterOverlay.js
@@ -9,6 +9,11 @@
* @extends Overlay
*/
AbuseFilterOverlay = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.confirmMessage Friendly confirmation
message expressing
+ * understanding.
+ */
defaults: {
confirmMessage: mw.msg(
'mobile-frontend-photo-ownership-confirm' )
},
diff --git a/javascripts/modules/editor/AbuseFilterPanel.js
b/javascripts/modules/editor/AbuseFilterPanel.js
index fa89905..735b88a 100644
--- a/javascripts/modules/editor/AbuseFilterPanel.js
+++ b/javascripts/modules/editor/AbuseFilterPanel.js
@@ -10,6 +10,11 @@
* @extends View
*/
AbuseFilterPanel = View.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.readMoreMsg A caption for the button
allowing the user to read
+ * more about the problems with their edit.
+ */
defaults: {
readMoreMsg: mw.msg(
'mobile-frontend-editor-abusefilter-read-more' )
},
diff --git a/javascripts/modules/editor/EditorOverlay.js
b/javascripts/modules/editor/EditorOverlay.js
index cd18ecf..e990fff 100644
--- a/javascripts/modules/editor/EditorOverlay.js
+++ b/javascripts/modules/editor/EditorOverlay.js
@@ -22,6 +22,15 @@
content: mw.template.get( 'mobile.editor.overlay',
'content.hogan' ),
anonWarning: mw.template.get( 'mobile.editor.common',
'EditorOverlayAnonWarning.hogan' )
},
+ /**
+ * @cfg {Object} defaults Default options hash. Extends
{EditorOverlayBase} defaults.
+ * @cfg {String} defaults.loginCaption A link with label to
login page.
+ * @cfg {String} defaults.signupCaption A link with label to
sign up page.
+ * @cfg {String} defaults.anonLabel Title for link to edit a
page without logging in.
+ * @cfg {String} defaults.anonSelector CSS selector for anon
link FIXME: is it?
+ * @cfg {String} defaults.anonMsg Warning message, when user
want to edit without
+ * logging in.
+ */
defaults: $.extend( {}, EditorOverlayBase.prototype.defaults, {
loginCaption: mw.msg(
'mobile-frontend-watchlist-cta-button-login' ),
signupCaption: mw.msg(
'mobile-frontend-watchlist-cta-button-signup' ),
diff --git a/javascripts/modules/editor/EditorOverlayBase.js
b/javascripts/modules/editor/EditorOverlayBase.js
index 41b191f..c224398 100644
--- a/javascripts/modules/editor/EditorOverlayBase.js
+++ b/javascripts/modules/editor/EditorOverlayBase.js
@@ -13,6 +13,30 @@
* @class EditorOverlayBase
*/
EditorOverlayBase = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash. Extends
{Overlay} defaults.
+ * @cfg {String} defaults.switcherButton HTML of the editor
switcher button.
+ * @cfg {String} defaults.sourceButton HTML of the button that
shows the page source.
+ * @cfg {String} defaults.veButton HTML of the button that
opens the Visual Editor.
+ * @cfg {String} defaults.continueMsg Caption for the next
button on edit form which takes
+ * you to the screen that shows a preview and license
information.
+ * @cfg {String} defaults.cancelMsg Caption for cancel button
on edit form.
+ * @cfg {String} defaults.closeMsg Caption for a button that
takes you back to editing
+ * @cfg {String} defaults.summaryRequestMsg Header above edit
summary input field asking
+ * the user to summarize the changes they made to the page.
+ * @cfg {String} defaults.summaryMsg A placeholder with
examples for the summary input
+ * field asking user what they changed.
+ * @cfg {String} defaults.placeholder Placeholder text for
empty sections.
+ * @cfg {String} defaults.waitMsg Text that displays while a
page edit is being saved.
+ * @cfg {String} defaults.waitIcon HTML of the icon that
displays while a page edit
+ * is being saved.
+ * @cfg {String} defaults.captchaMsg Placeholder for captcha
input field.
+ * @cfg {String} defaults.captchaTryAgainMsg A message shown
when user enters wrong CAPTCHA
+ * and a new one is displayed.
+ * @cfg {String} defaults.switchMsg Label for button that
allows the user to switch between
+ * two different editing interfaces.
+ * from edit preview screen.
+ */
defaults: $.extend( {}, Overlay.prototype.defaults, {
switcherButton: new Icon( {
tagName: 'button',
diff --git a/javascripts/modules/infobox/Infobox.js
b/javascripts/modules/infobox/Infobox.js
index f2a0ab2..c1a5d8a 100644
--- a/javascripts/modules/infobox/Infobox.js
+++ b/javascripts/modules/infobox/Infobox.js
@@ -16,6 +16,13 @@
template: mw.template.get( 'mobile.infobox', 'Infobox.hogan' ),
className: 'wikidata-infobox',
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.spinner HTML of the spinner icon
+ * @cfg {String} defaults.description WikiData description.
+ * Defaults to 'A Wikipedia page in need of a description.'
+ * @cfg {Array} defaults.rows FIXME: document
+ */
defaults: {
spinner: icons.spinner().toHtmlString(),
description: mw.config.get( 'wgMFDescription' ) ||
diff --git a/javascripts/modules/issues/CleanupOverlay.js
b/javascripts/modules/issues/CleanupOverlay.js
index 763e710..773b380 100644
--- a/javascripts/modules/issues/CleanupOverlay.js
+++ b/javascripts/modules/issues/CleanupOverlay.js
@@ -17,6 +17,10 @@
templatePartials: {
content: mw.template.get( 'mobile.issues',
'OverlayContent.hogan' )
},
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.className Class name of the
'cleanup-gray' icon.
+ */
defaults: {
className: icon.getClassName()
},
diff --git a/javascripts/modules/languages/LanguageOverlay.js
b/javascripts/modules/languages/LanguageOverlay.js
index d227ea4..ee25c81 100644
--- a/javascripts/modules/languages/LanguageOverlay.js
+++ b/javascripts/modules/languages/LanguageOverlay.js
@@ -9,6 +9,12 @@
* @extends Overlay
*/
LanguageOverlay = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.heading The title for the list of
languages for a page.
+ * @cfg {String} defaults.placeholder Header for overlay when
click on language on
+ * settings page.
+ */
defaults: {
heading: mw.msg( 'mobile-frontend-language-heading' ),
placeholder: mw.msg(
'mobile-frontend-language-site-choose' )
diff --git a/javascripts/modules/mediaViewer/ImageOverlay.js
b/javascripts/modules/mediaViewer/ImageOverlay.js
index 2bd8d7e..af41000 100644
--- a/javascripts/modules/mediaViewer/ImageOverlay.js
+++ b/javascripts/modules/mediaViewer/ImageOverlay.js
@@ -18,6 +18,13 @@
template: mw.template.get( 'mobile.mediaViewer',
'Overlay.hogan' ),
closeOnBack: true,
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.cancelButton HTML of the cancel
button.
+ * @cfg {String} defaults.detailsMsg Caption for a button
leading to the details
+ * of a media file (e.g. an image) in a preview.
+ * @cfg {String} defaults.licenseLinkMsg Link to license
information in media viewer.
+ */
defaults: {
cancelButton: new Icon( {
tagName: 'button',
diff --git a/javascripts/modules/nearby/Nearby.js
b/javascripts/modules/nearby/Nearby.js
index 0f3b973..c113f01 100644
--- a/javascripts/modules/nearby/Nearby.js
+++ b/javascripts/modules/nearby/Nearby.js
@@ -38,6 +38,11 @@
pageList: PageList.prototype.template
},
template: mw.template.get( 'mobile.nearby', 'Nearby.hogan' ),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.spinner HTML of the spinner icon with
+ * "an informative message telling user that their location is
being looked up" title
+ */
defaults: {
spinner: icons.spinner( {
title: mw.msg( 'mobile-frontend-nearby-loading'
)
diff --git a/javascripts/modules/notifications/NotificationsOverlay.js
b/javascripts/modules/notifications/NotificationsOverlay.js
index 7222edf..c0a2c12 100644
--- a/javascripts/modules/notifications/NotificationsOverlay.js
+++ b/javascripts/modules/notifications/NotificationsOverlay.js
@@ -15,6 +15,13 @@
content: mw.template.get(
'mobile.notifications.overlay', 'content.hogan' ),
footer: mw.template.get( 'mobile.overlays',
'OverlayFooterLink.hogan' )
},
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.heading Heading text
+ * @cfg {String} defaults.link Link to 'Special:Notifications'
+ * @cfg {String} defaults.linkMsg Message of defaults.link
+ * @cfg {String} defaults.linkClass Class of defaults.link
+ */
defaults: {
heading: mw.msg( 'notifications' ),
link: mw.util.getUrl( 'Special:Notifications' ),
diff --git a/javascripts/modules/references/ReferencesDrawer.js
b/javascripts/modules/references/ReferencesDrawer.js
index 595edf2..5bb5245 100644
--- a/javascripts/modules/references/ReferencesDrawer.js
+++ b/javascripts/modules/references/ReferencesDrawer.js
@@ -9,6 +9,12 @@
* @extends Drawer
*/
ReferencesDrawer = Drawer.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.cancelButton HTML of the button that
closes the drawer.
+ * @cfg {String} defaults.className Spaces separated list of
classes of the drawer.
+ * @cfg {Hogan.Template} template Template of the drawer.
+ */
defaults: {
cancelButton: new Icon( {
name: 'cancel',
diff --git a/javascripts/modules/references/ReferencesDrawerBeta.js
b/javascripts/modules/references/ReferencesDrawerBeta.js
index b6eb654..6b1022f 100644
--- a/javascripts/modules/references/ReferencesDrawerBeta.js
+++ b/javascripts/modules/references/ReferencesDrawerBeta.js
@@ -9,6 +9,12 @@
* @extends ReferencesDrawer
*/
ReferencesDrawerBeta = ReferencesDrawer.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.cancelButton HTML of the button that
closes the drawer.
+ * @cfg {String} defaults.citation HTML of the citation icon.
+ * @cfg {Hogan.Template} template of the drawer.
+ */
defaults: {
cancelButton: new Icon( {
name: 'cancel-light',
diff --git a/javascripts/modules/search/SearchOverlay.js
b/javascripts/modules/search/SearchOverlay.js
index 89f57cf..c9d22e0 100644
--- a/javascripts/modules/search/SearchOverlay.js
+++ b/javascripts/modules/search/SearchOverlay.js
@@ -19,6 +19,21 @@
SearchOverlay = Overlay.extend( {
className: 'overlay search-overlay',
template: mw.template.get( 'mobile.search',
'SearchOverlay.hogan' ),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.clearIcon HTML of the button that
clears the search text.
+ * @cfg {String} defaults.searchTerm Search text.
+ * @cfg {String} defaults.placeholderMsg Search input
placeholder text.
+ * @cfg {String} defaults.clearMsg Tooltip for clear button
that appears when you type
+ * into search box.
+ * @cfg {String} defaults.searchContentMsg Caption for a button
performing full text
+ * search of a given search query.
+ * @cfg {String} defaults.noResultsMsg Message informing user
that no pages were found
+ * for a given query.
+ * @cfg {String} defaults.searchContentNoResultsMsg Used when
no pages with matching
+ * titles were found.
+ * @cfg {String} defaults.action FIXME: document
+ */
defaults: {
clearIcon: new Icon( {
tagName: 'button',
diff --git a/javascripts/modules/talk/TalkOverlay.js
b/javascripts/modules/talk/TalkOverlay.js
index 8b83d26..afa16a8 100644
--- a/javascripts/modules/talk/TalkOverlay.js
+++ b/javascripts/modules/talk/TalkOverlay.js
@@ -18,11 +18,22 @@
content: mw.template.get(
'mobile.talk.overlays', 'content.hogan' ),
footer: mw.template.get( 'mobile.overlays',
'OverlayFooterLink.hogan' )
} ),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {Array} defaults.headings A list of sections to
render heading links for.
+ * If not set ajax request will be performed.
+ * @cfg {String} defaults.heading Heading for talk
overlay.
+ * @cfg {String} defaults.leadHeading Heading for a
discussion which has no heading
+ * (lead section of talk page).
+ * @cfg {String} defaults.headerButtonsListClassName
Class name of the header buttons list
+ * @cfg {Array} defaults.headerButtons Objects that
will be used as defaults for
+ * generating header buttons. Default list includes an
'add' button, which opens
+ * a new talk overlay.
+ * @cfg {String} defaults.linkMsg Used as label for
link to the talk page
+ * (Talk:ArticleName) in Talk Overlay.
+ * @cfg {String} defaults.linkClass Class name of
defaults.linkMsg.
+ */
defaults: {
- /**
- * A list of sections to render heading links
for. If not set ajax request will be performed.
- * @type {Array}
- **/
headings: undefined,
heading: '<strong>' + mw.msg(
'mobile-frontend-talk-overlay-header' ) + '</strong>',
leadHeading: mw.msg(
'mobile-frontend-talk-overlay-lead-header' ),
diff --git a/javascripts/modules/talk/TalkSectionAddOverlay.js
b/javascripts/modules/talk/TalkSectionAddOverlay.js
index a489ef3..2f939d5 100644
--- a/javascripts/modules/talk/TalkSectionAddOverlay.js
+++ b/javascripts/modules/talk/TalkSectionAddOverlay.js
@@ -12,6 +12,15 @@
* @extends Overlay
*/
TalkSectionAddOverlay = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash. Extends
{Overlay} defaults.
+ * @cfg {String} defaults.cancelMsg Caption for cancel button
on edit form.
+ * @cfg {String} defaults.topicTitlePlaceHolder Placeholder
text to prompt user to add
+ * a talk page topic subject.
+ * @cfg {String} defaults.topicContentPlaceHolder Placeholder
text to prompt user to add
+ * content to talk page content.
+ * @cfg {String} defaults.editingMsg Label for button which
submits a new talk page topic.
+ */
defaults: $.extend( {}, Overlay.prototype.defaults, {
cancelMsg: mw.msg( 'mobile-frontend-editor-cancel' ),
topicTitlePlaceHolder: mw.msg(
'mobile-frontend-talk-add-overlay-subject-placeholder' ),
diff --git a/javascripts/modules/talk/TalkSectionOverlay.js
b/javascripts/modules/talk/TalkSectionOverlay.js
index b2b0651..146bdd5 100644
--- a/javascripts/modules/talk/TalkSectionOverlay.js
+++ b/javascripts/modules/talk/TalkSectionOverlay.js
@@ -17,6 +17,14 @@
header: mw.template.get( 'mobile.talk.overlays',
'Section/header.hogan' ),
content: mw.template.get( 'mobile.talk.overlays',
'Section/content.hogan' )
},
+ /**
+ * @cfg {Object} defaults Default options hash. Extends
{Overlay} defaults.
+ * @cfg {String} defaults.title Title
+ * @cfg {Section} defaults.section FIXME: document
+ * @cfg {String} defaults.reply Reply heading.
+ * @cfg {String} defaults.info Message that informs the user
their talk reply will be
+ * automatically signed.
+ */
defaults: $.extend( {}, Overlay.prototype.defaults, {
title: undefined,
section: undefined,
diff --git a/javascripts/modules/toc/TableOfContents.js
b/javascripts/modules/toc/TableOfContents.js
index 6e0687f..9b692e1 100644
--- a/javascripts/modules/toc/TableOfContents.js
+++ b/javascripts/modules/toc/TableOfContents.js
@@ -13,6 +13,11 @@
templatePartials: {
tocHeading: mw.template.get( 'mobile.toc',
'heading.hogan' )
},
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.tocIcon HTML of the Table of Contents
icon.
+ * @cfg {String} defaults.contentsMsg TOC contents message.
+ */
defaults: {
tocIcon: new Icon( {
name: 'toc',
diff --git a/javascripts/modules/tutorials/PageActionOverlay.js
b/javascripts/modules/tutorials/PageActionOverlay.js
index 1c891eb..7ab0a99 100644
--- a/javascripts/modules/tutorials/PageActionOverlay.js
+++ b/javascripts/modules/tutorials/PageActionOverlay.js
@@ -9,6 +9,10 @@
*/
PageActionOverlay = ContentOverlay.extend( {
template: mw.template.get( 'mobile.contentOverlays',
'PageActionOverlay.hogan' ),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.cancelMsg Cancel message.
+ */
defaults: {
cancelMsg: mw.msg( 'cancel' )
}
diff --git a/javascripts/modules/uploads/LeadPhotoUploaderButton.js
b/javascripts/modules/uploads/LeadPhotoUploaderButton.js
index 5f53503..65e6dd1 100644
--- a/javascripts/modules/uploads/LeadPhotoUploaderButton.js
+++ b/javascripts/modules/uploads/LeadPhotoUploaderButton.js
@@ -17,6 +17,12 @@
template: mw.template.get( 'mobile.upload.ui',
'LeadButton.hogan' ),
className: uploadIcon.getClassName(),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.buttonCaption Caption that is a call
to action to add the first image.
+ * @cfg {Boolean} defaults.insertInPage FIXME: document
+ * @cfg {String} defaults.el FIXME: document
+ */
defaults: {
buttonCaption: mw.msg( 'mobile-frontend-photo-upload' ),
insertInPage: true,
diff --git a/javascripts/modules/uploads/PhotoUploadOverlay.js
b/javascripts/modules/uploads/PhotoUploadOverlay.js
index 9210547..79b885b 100644
--- a/javascripts/modules/uploads/PhotoUploadOverlay.js
+++ b/javascripts/modules/uploads/PhotoUploadOverlay.js
@@ -16,6 +16,18 @@
* @extends Overlay
*/
PhotoUploadOverlay = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.descriptionPlaceholder Placeholder
text prompting user to add
+ * a mandatory caption to an image.
+ * @cfg {String} defaults.help A link that allows the user to
open more information
+ * about photo ownership.
+ * @cfg {String} defaults.ownerStatement A statement saying the
user created the image.
+ * @cfg {String} defaults.heading A heading instructing the
user to describe uploaded image.
+ * @cfg {String} defaults.headerButtonsListClassName Class name
of the header buttons list.
+ * @cfg {Array} defaults.headerButtons Objects that will be
used as defaults to create
+ * header buttons. Defaults to the 'submit' button only.
+ */
defaults: {
descriptionPlaceholder: mw.msg(
'mobile-frontend-photo-caption-placeholder' ),
help: mw.msg( 'mobile-frontend-photo-ownership-help' ),
diff --git a/javascripts/modules/uploads/PhotoUploadProgress.js
b/javascripts/modules/uploads/PhotoUploadProgress.js
index 21485e8..4c23f50 100644
--- a/javascripts/modules/uploads/PhotoUploadProgress.js
+++ b/javascripts/modules/uploads/PhotoUploadProgress.js
@@ -11,6 +11,11 @@
* @extends Overlay
*/
PhotoUploadProgress = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash. Extends
{Overlay} defaults.
+ * @cfg {String} defaults.uploadingMsg A message telling the
user that an image is being
+ * uploaded.
+ */
defaults: $.extend( {}, Overlay.prototype.defaults, {
uploadingMsg: mw.msg( 'mobile-frontend-image-uploading'
)
} ),
diff --git a/javascripts/modules/uploads/UploadTutorial.js
b/javascripts/modules/uploads/UploadTutorial.js
index 70fbf3e..5407378 100644
--- a/javascripts/modules/uploads/UploadTutorial.js
+++ b/javascripts/modules/uploads/UploadTutorial.js
@@ -16,6 +16,18 @@
template: mw.template.get( 'mobile.uploads',
'UploadTutorial.hogan' ),
className: 'overlay carousel tutorial content-overlay',
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.slideLeftButton HTML of the slide
left button.
+ * @cfg {String} defaults.slideRightButton HTML of the slide
right button.
+ * @cfg {Boolean} defaults.inBeta Whether the user is a beta
group member.
+ * @cfg {Array} defaults.pages Objects that will be used as
options to create pages.
+ * Defaults to the following pages:
+ * * Informative statement about where images come from.
+ * * Guidance on avoiding copyright materials shown to first
time users on
+ * [[Special:Uploads]].
+ * * Question asking user if they understood the tutorial.
+ */
defaults: {
slideLeftButton: new Icon( {
name: 'previous',
diff --git a/javascripts/modules/watchstar/Watchstar.js
b/javascripts/modules/watchstar/Watchstar.js
index a18e8fc..e671c32 100644
--- a/javascripts/modules/watchstar/Watchstar.js
+++ b/javascripts/modules/watchstar/Watchstar.js
@@ -23,6 +23,10 @@
* @extends View
*/
Watchstar = View.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {Page} defaults.page Current page.
+ */
defaults: {
page: M.getCurrentPage()
},
diff --git a/javascripts/modules/wikigrok/WikiGrokDialog.js
b/javascripts/modules/wikigrok/WikiGrokDialog.js
index e0e453c..48ac958 100644
--- a/javascripts/modules/wikigrok/WikiGrokDialog.js
+++ b/javascripts/modules/wikigrok/WikiGrokDialog.js
@@ -21,6 +21,20 @@
WikiGrokDialog = Panel.extend( {
version: 'a',
className: 'wikigrok',
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {Boolean} defaults.beginQuestions Whether to show
questions.
+ * @cfg {String} defaults.taskToken Task token used in schemas.
+ * @cfg {Boolean} defaults.thankUser Whether to show the thanks
message.
+ * @cfg {String} defaults.closeMsg Text for the button in an
overlay that, when clicked,
+ * dismisses the overlay.
+ * @cfg {String} defaults.contentMsg Message that tells what to
do.
+ * Defaults to 'Improve Wikipedia by tagging information on
this page'.
+ * @cfg {Array} defaults.buttons Objects that will be used as
options to create buttons.
+ * Defaults to 'No, thanks' and 'Okay!' buttons.
+ * @cfg {String} defaults.noticeMsg A link that opens an
overlay with more information about
+ * WikiGrok.
+ */
defaults: {
beginQuestions: false,
taskToken: mw.user.generateRandomSessionId(),
diff --git a/javascripts/modules/wikigrok/WikiGrokMoreInfo.js
b/javascripts/modules/wikigrok/WikiGrokMoreInfo.js
index bb65a2d..064e95b 100644
--- a/javascripts/modules/wikigrok/WikiGrokMoreInfo.js
+++ b/javascripts/modules/wikigrok/WikiGrokMoreInfo.js
@@ -8,6 +8,10 @@
* @extends Overlay
*/
WikiGrokMoreInfo = Overlay.extend( {
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} defaults.heading Heading of the overlay.
+ */
defaults: {
heading: '<strong>About</strong>'
},
diff --git a/javascripts/specials/uploads/PhotoList.js
b/javascripts/specials/uploads/PhotoList.js
index 4d19073..1331f8c 100644
--- a/javascripts/specials/uploads/PhotoList.js
+++ b/javascripts/specials/uploads/PhotoList.js
@@ -14,6 +14,10 @@
*/
PhotoList = View.extend( {
template: mw.template.get( 'mobile.special.uploads.scripts',
'PhotoList.hogan' ),
+ /**
+ * @cfg {Object} defaults Default options hash.
+ * @cfg {String} HTML of the spinner icon.
+ */
defaults: {
spinner: icons.spinner().toHtmlString()
},
--
To view, visit https://gerrit.wikimedia.org/r/177880
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ide52d0ab1fe7edd3c1aabf3f6d01ef60bad648a7
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/MobileFrontend
Gerrit-Branch: master
Gerrit-Owner: Bmansurov <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
