From c821ca154b0e476185633c9cbaaadab13b0c88ab Mon Sep 17 00:00:00 2001 From: Thiemo Kreuz Date: Fri, 22 Jul 2022 18:11:37 +0200 Subject: [PATCH] Document what "current page" means in two-pane layout Change-Id: I37b26a9f01031d4910ff773977a89eb46a4c19ac --- .../layouts/ve.ui.MWTwoPaneTransclusionDialogLayout.js | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/modules/ve-mw/ui/layouts/ve.ui.MWTwoPaneTransclusionDialogLayout.js b/modules/ve-mw/ui/layouts/ve.ui.MWTwoPaneTransclusionDialogLayout.js index d5a302c720..8f711007ac 100644 --- a/modules/ve-mw/ui/layouts/ve.ui.MWTwoPaneTransclusionDialogLayout.js +++ b/modules/ve-mw/ui/layouts/ve.ui.MWTwoPaneTransclusionDialogLayout.js @@ -15,6 +15,13 @@ * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the * pages of the booklet. * @property {Object.} pages + * @property {string} currentPageName Name of the currently selected transclusion item (top-level + * part or template parameter). Typically represented as a blue bar in the sidebar. Special cases + * you should be aware of: + * - An unchecked parameter exists as an item in the sidebar, but not as a page in the content + * pane. + * - A parameter placeholder (to add an undocumented parameter) exists as a page in the content + * pane, but has no corresponding item in the sidebar. */ ve.ui.MWTwoPaneTransclusionDialogLayout = function VeUiMWTwoPaneTransclusionDialogLayout( config ) { // Configuration initialization @@ -24,8 +31,8 @@ ve.ui.MWTwoPaneTransclusionDialogLayout = function VeUiMWTwoPaneTransclusionDial ve.ui.MWTwoPaneTransclusionDialogLayout.super.call( this, config ); // Properties - this.currentPageName = null; this.pages = {}; + this.currentPageName = null; this.ignoreFocus = false; this.stackLayout = new ve.ui.MWVerticalLayout(); this.setContentPanel( this.stackLayout );