wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-15 18:39:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Filter right content side of the template dialog as well

Browse source 
I came up with a new event to do this. This event is triggered
individually for each parameter. An alternative is a single
event that gets a list of visible parameters. Is this better?
What do you think?

Bug: T288202
Change-Id: Ia44da16917c28171a01aef0f1c613dcd5d3266ba
This commit is contained in:
Thiemo Kreuz 2021-08-05 14:36:10 +02:00
parent fce48b0958
commit 3e5a2d6c82
3 changed files with 41 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
View file

@ -475,6 +475,7 @@ ve.ui.MWTemplateDialog.prototype.getSetupProcess = function ( data ) {
this.pocSidebar = new ve.ui.MWTransclusionOutlineContainerWidget(
this.bookletLayout
);
this.pocSidebar.connect( this, { filterParameter: 'onFilterParameter' } );
} else {
this.pocSidebar.clear();
}
@ -575,6 +576,16 @@ ve.ui.MWTemplateDialog.prototype.initializeNewTemplateParameters = function () {
*/
ve.ui.MWTemplateDialog.prototype.initializeTemplateParameters = function () {};
/**
* @private
*/
ve.ui.MWTemplateDialog.prototype.onFilterParameter = function ( partId, isVisible ) {
var page = this.bookletLayout.getPage( partId );
if ( page ) {
page.toggle( isVisible );
}
};
/**
* @inheritdoc
*/

9
modules/ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineContainerWidget.js
View file

@ -32,6 +32,12 @@ OO.inheritClass( ve.ui.MWTransclusionOutlineContainerWidget, OO.ui.Widget );
/* Events */
/**
* @event filterParameter
* @param {string} partId Unique id of the parameter, e.g. something like "part_1/param1"
* @param {boolean} isVisible
*/
/**
* @param {ve.dm.MWTransclusionPartModel|null} removed Removed part
* @param {ve.dm.MWTransclusionPartModel|null} added Added part
@ -92,6 +98,9 @@ ve.ui.MWTransclusionOutlineContainerWidget.prototype.addPartWidget = function (
if ( part instanceof ve.dm.MWTemplateModel ) {
widget = new ve.ui.MWTransclusionOutlineTemplateWidget( part );
// This forwards events from the nested ve.ui.MWTransclusionOutlineTemplateWidget upwards.
// The array syntax is a way to call `this.emit( 'filterParameter' )`.
widget.connect( this, { filterParameter: [ 'emit', 'filterParameter' ] } );
} else if ( part instanceof ve.dm.MWTemplatePlaceholderModel ) {
widget = new ve.ui.MWTransclusionOutlinePlaceholderWidget( part );
} else if ( part instanceof ve.dm.MWTransclusionContentModel ) {

22
modules/ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js
View file

@ -72,6 +72,18 @@ ve.ui.MWTransclusionOutlineTemplateWidget = function VeUiMWTransclusionOutlineTe
OO.inheritClass( ve.ui.MWTransclusionOutlineTemplateWidget, ve.ui.MWTransclusionOutlinePartWidget );
/* Events */
/**
* Triggered when the user uses the search widget at the top to filter the list of parameters.
*
* @event filterParameter
* @param {string} partId Unique id of the parameter, e.g. something like "part_1/param1"
* @param {boolean} isVisible
*/
/* Methods */
/**
* @param {string} paramName
* @return {ve.ui.MWTemplateOutlineParameterCheckboxLayout}
@ -169,9 +181,12 @@ ve.ui.MWTransclusionOutlineTemplateWidget.prototype.onCheckboxListChange = funct
* parameter's primary name, aliases, label, and description. But not e.g. the example value.
*
* @param {string} query user input
* @fires filterParameter
*/
ve.ui.MWTransclusionOutlineTemplateWidget.prototype.onFilterChange = function ( query ) {
var spec = this.templateModel.getSpec(),
var self = this,
template = this.templateModel,
spec = this.templateModel.getSpec(),
checkboxes = this.parameters,
nothingFound = true;
@ -196,6 +211,11 @@ ve.ui.MWTransclusionOutlineTemplateWidget.prototype.onFilterChange = function (
checkbox.toggle( foundSomeMatch );
nothingFound = nothingFound && !foundSomeMatch;
var param = template.getParameter( paramName );
if ( param ) {
self.emit( 'filterParameter', param.getId(), foundSomeMatch );
}
} );
this.infoWidget.toggle( nothingFound );