1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/*!
* VisualEditor UserInterface MWParameterSearchWidget class.
*
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWParameterSearchWidget object.
*
* @class
* @extends OO.ui.SearchWidget
*
* @constructor
* @param {ve.dm.MWTemplateModel} template Template model
* @param {Object} [config] Configuration options
* @cfg {number|null} [limit=3] Limit on the number of initial options to show, null to show all
*/
ve.ui.MWParameterSearchWidget = function VeUiMWParameterSearchWidget( template, config ) {
// Configuration initialization
config = ve.extendObject( {
placeholder: ve.msg( 'visualeditor-parameter-input-placeholder' ),
limit: 3
}, config );
// Parent constructor
ve.ui.MWParameterSearchWidget.super.call( this, config );
// Properties
this.template = template;
this.index = [];
this.showAll = !!config.showAll;
this.limit = config.limit || null;
// Events
this.template.connect( this, { add: 'buildIndex', remove: 'buildIndex' } );
this.getResults().connect( this, { choose: 'onSearchResultsChoose' } );
this.query.$input.attr( 'aria-label', ve.msg( 'visualeditor-parameter-input-placeholder' ) );
// Initialization
this.$element.addClass( 've-ui-mwParameterSearchWidget' );
this.query.$input.attr( 'aria-label', ve.msg( 'visualeditor-parameter-input-placeholder' ) );
this.buildIndex();
};
/* Inheritance */
OO.inheritClass( ve.ui.MWParameterSearchWidget, OO.ui.SearchWidget );
/* Events */
/**
* @event choose
* @param {string|null} name Parameter name or null if no item is selected
*/
/* Methods */
/**
* Handle select widget select events.
*
* @param {string} value New value
*/
ve.ui.MWParameterSearchWidget.prototype.onQueryChange = function () {
// Parent method
ve.ui.MWParameterSearchWidget.super.prototype.onQueryChange.call( this );
// Populate
this.addResults();
};
/**
* Handle SelectWidget choose events.
*
* @param {OO.ui.OptionWidget} item Selected item
* @fires choose
* @fires showAll
*/
ve.ui.MWParameterSearchWidget.prototype.onSearchResultsChoose = function ( item ) {
if ( item instanceof ve.ui.MWParameterResultWidget ) {
this.emit( 'choose', item.getData().name );
} else if ( item instanceof ve.ui.MWMoreParametersResultWidget ) {
this.showAll = true;
this.addResults();
this.emit( 'showAll' );
}
};
/**
* Build a searchable index of parameters.
*
* @param {ve.dm.MWTemplateSpecModel} spec Template specification
*/
ve.ui.MWParameterSearchWidget.prototype.buildIndex = function () {
var i, len, name, label, aliases, description,
spec = this.template.getSpec(),
knownParams = spec.getParameterNames();
this.index.length = 0;
for ( i = 0, len = knownParams.length; i < len; i++ ) {
name = knownParams[ i ];
// Skip parameters already in use
if ( this.template.hasParameter( name ) ) {
continue;
}
label = spec.getParameterLabel( name );
aliases = spec.getParameterAliases( name );
description = spec.getParameterDescription( name );
this.index.push( {
// Query information
text: [ label, description ].join( ' ' ).toLowerCase(),
names: [ name ].concat( aliases ).join( '|' ).toLowerCase(),
// Display information
name: name,
label: label,
aliases: aliases,
description: description,
deprecated: spec.isParameterDeprecated( name )
} );
}
// Re-populate
this.onQueryChange();
};
/**
* Handle media query response events.
*/
ve.ui.MWParameterSearchWidget.prototype.addResults = function () {
var i, len, item, textMatch, nameMatch, remainder,
exactMatch = false,
value = this.query.getValue().trim().replace( /[|{}]/g, '' ),
query = value.toLowerCase(),
hasQuery = !!query.length,
items = [];
this.results.clearItems();
for ( i = 0, len = this.index.length; i < len; i++ ) {
item = this.index[ i ];
if ( hasQuery ) {
textMatch = item.text.indexOf( query ) >= 0;
nameMatch = item.names.indexOf( query ) >= 0;
}
if ( !hasQuery || textMatch || nameMatch ) {
// Only show exact matches for deprecated params
if ( item.deprecated && query !== item.name && item.aliases.indexOf( query ) === -1 ) {
continue;
}
items.push( new ve.ui.MWParameterResultWidget( { data: item } ) );
if ( hasQuery && nameMatch ) {
exactMatch = true;
}
}
if ( !hasQuery && !this.showAll && items.length >= this.limit ) {
remainder = len - i;
break;
}
}
if ( hasQuery && !exactMatch && value.length && !this.template.hasParameter( value ) ) {
items.unshift( new ve.ui.MWParameterResultWidget( {
data: {
name: value,
label: value,
aliases: [],
description: ve.msg( 'visualeditor-parameter-search-unknown' )
}
} ) );
}
if ( !items.length ) {
items.push( new ve.ui.MWNoParametersResultWidget( {
data: {},
disabled: true
} ) );
} else if ( remainder ) {
items.push( new ve.ui.MWMoreParametersResultWidget( {
data: { remainder: remainder }
} ) );
}
this.results.addItems( items );
if ( hasQuery ) {
this.results.highlightItem( this.results.findFirstSelectableItem() );
}
};
|
