Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7421703
ve.ui.MWAddParameterPage.js
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
6 KB
Referenced Files
None
Subscribers
None
ve.ui.MWAddParameterPage.js
View Options
/**
* Placeholder page for a currently unnamed parameter. Represented as an unnamed
* {@see ve.dm.MWParameterModel} in the corresponding {@see ve.dm.MWTemplateModel}.
*
* @class
* @extends OO.ui.PageLayout
*
* @constructor
* @param {ve.dm.MWParameterModel} parameter Reference to a placeholder parameter with an empty
* name, as well as to the template the parameter belongs to
* @param {string} name Unique symbolic name of page
* @param {Object} [config] Configuration options
* @param {jQuery} [config.$overlay] Overlay to render dropdowns in
*/
ve
.
ui
.
MWAddParameterPage
=
function
VeUiMWAddParameterPage
(
parameter
,
name
,
config
)
{
// Parent constructor
ve
.
ui
.
MWAddParameterPage
.
super
.
call
(
this
,
name
,
ve
.
extendObject
(
{
scrollable
:
false
},
config
)
);
this
.
template
=
parameter
.
getTemplate
();
this
.
isExpanded
=
false
;
// Header button to expand
this
.
addParameterInputHeader
=
new
OO
.
ui
.
ButtonWidget
(
{
label
:
ve
.
msg
(
'visualeditor-dialog-transclusion-add-undocumented-param'
),
icon
:
'add'
,
framed
:
false
,
inline
:
true
,
classes
:
[
've-ui-mwTransclusionDialog-addParameterFieldset-header'
]
}
)
.
connect
(
this
,
{
click
:
'togglePlaceholder'
}
);
this
.
addParameterFieldset
=
new
OO
.
ui
.
FieldsetLayout
(
{
label
:
this
.
addParameterInputHeader
.
$element
,
classes
:
[
've-ui-mwTransclusionDialog-addParameterFieldset'
]
}
);
// Init visibility
this
.
togglePlaceholder
(
false
);
// Initialization
this
.
$element
.
addClass
(
've-ui-mwAddParameterPage'
)
.
append
(
this
.
addParameterFieldset
.
$element
);
};
/* Inheritance */
OO
.
inheritClass
(
ve
.
ui
.
MWAddParameterPage
,
OO
.
ui
.
PageLayout
);
/* Events */
/**
* @event ve.ui.MWAddParameterPage#templateParameterAdded
* @param {string} id Page ID
*/
/* Methods */
/**
* @private
*/
ve
.
ui
.
MWAddParameterPage
.
prototype
.
initialize
=
function
()
{
this
.
template
.
connect
(
this
,
{
// There is a "change" event, but it triggers way to often even for content changes
add
:
'onTemplateParametersChanged'
,
remove
:
'onTemplateParametersChanged'
}
);
this
.
paramInputField
=
new
OO
.
ui
.
TextInputWidget
(
{
placeholder
:
ve
.
msg
(
'visualeditor-dialog-transclusion-add-param-placeholder'
)
}
)
.
connect
(
this
,
{
change
:
'updateParameterNameValidation'
,
enter
:
'onParameterNameSubmitted'
}
);
this
.
saveButton
=
new
OO
.
ui
.
ButtonWidget
(
{
label
:
ve
.
msg
(
'visualeditor-dialog-transclusion-add-param-save'
),
flags
:
[
'progressive'
],
disabled
:
true
}
)
.
connect
(
this
,
{
click
:
'onParameterNameSubmitted'
}
);
this
.
actionFieldLayout
=
new
OO
.
ui
.
ActionFieldLayout
(
this
.
paramInputField
,
this
.
saveButton
,
{
classes
:
[
've-ui-mwTransclusionDialog-addParameterFieldset-input'
],
align
:
'top'
}
);
const
link
=
this
.
template
.
getTitle
()
||
this
.
template
.
getTarget
().
wt
;
const
$helpText
=
mw
.
message
(
'visualeditor-dialog-transclusion-add-param-help'
,
link
).
parseDom
();
ve
.
init
.
platform
.
linkCache
.
styleElement
(
link
,
$helpText
.
filter
(
'a:not(.external)'
)
);
// Copied from {@see OO.ui.FieldsetLayout} because there is no method to do this later
const
helpWidget
=
new
OO
.
ui
.
LabelWidget
(
{
label
:
$helpText
,
classes
:
[
'oo-ui-inline-help'
]
}
);
ve
.
targetLinksToNewWindow
(
helpWidget
.
$element
[
0
]
);
this
.
addParameterFieldset
.
$element
.
append
(
helpWidget
.
$element
,
this
.
addParameterFieldset
.
$group
,
this
.
actionFieldLayout
.
$element
);
};
/**
* @inheritDoc OO.ui.PanelLayout
*/
ve
.
ui
.
MWAddParameterPage
.
prototype
.
focus
=
function
()
{
this
.
togglePlaceholder
(
true
);
};
/**
* @private
*/
ve
.
ui
.
MWAddParameterPage
.
prototype
.
onTemplateParametersChanged
=
function
()
{
this
.
updateParameterNameValidation
(
this
.
paramInputField
.
getValue
()
);
};
/**
* @private
* @param {string} value
*/
ve
.
ui
.
MWAddParameterPage
.
prototype
.
updateParameterNameValidation
=
function
(
value
)
{
const
paramName
=
value
.
trim
(),
errors
=
this
.
getValidationErrors
(
paramName
);
this
.
actionFieldLayout
.
setErrors
(
errors
);
this
.
saveButton
.
setDisabled
(
!
paramName
||
errors
.
length
);
};
/**
* @private
* @fires ve.ui.MWAddParameterPage#templateParameterAdded
*/
ve
.
ui
.
MWAddParameterPage
.
prototype
.
onParameterNameSubmitted
=
function
()
{
const
name
=
this
.
paramInputField
.
getValue
().
trim
();
if
(
!
name
||
this
.
saveButton
.
isDisabled
()
)
{
return
;
}
this
.
paramInputField
.
setValue
(
''
);
if
(
this
.
template
.
hasParameter
(
name
)
)
{
return
;
}
const
param
=
new
ve
.
dm
.
MWParameterModel
(
this
.
template
,
name
);
this
.
template
.
addParameter
(
param
);
this
.
emit
(
'templateParameterAdded'
,
param
.
getId
()
);
ve
.
track
(
'activity.transclusion'
,
{
action
:
'add-unknown-parameter'
}
);
};
/**
* @private
* @param {string} name Parameter name or alias
* @return {jQuery[]} An array as accepted by {@see OO.ui.FieldLayout.setErrors}
*/
ve
.
ui
.
MWAddParameterPage
.
prototype
.
getValidationErrors
=
function
(
name
)
{
if
(
!
name
)
{
return
[];
}
const
forbiddenCharacter
=
name
.
match
(
/[={|}]/
);
if
(
forbiddenCharacter
)
{
return
[
mw
.
message
(
'visualeditor-dialog-transclusion-add-param-error-forbidden-char'
,
forbiddenCharacter
[
0
]
).
parseDom
()
];
}
const
spec
=
this
.
template
.
getSpec
();
let
key
;
if
(
spec
.
getParameterAliases
(
name
).
includes
(
name
)
)
{
key
=
'visualeditor-dialog-transclusion-add-param-error-alias'
;
}
else
if
(
this
.
template
.
hasParameter
(
name
)
)
{
key
=
'visualeditor-dialog-transclusion-add-param-error-exists-selected'
;
}
else
if
(
spec
.
isParameterDeprecated
(
name
)
)
{
key
=
'visualeditor-dialog-transclusion-add-param-error-deprecated'
;
}
else
if
(
spec
.
isKnownParameterOrAlias
(
name
)
)
{
key
=
'visualeditor-dialog-transclusion-add-param-error-exists-unselected'
;
}
if
(
!
key
)
{
return
[];
}
const
label
=
spec
.
getParameterLabel
(
this
.
template
.
getOriginalParameterName
(
name
)
),
// eslint-disable-next-line mediawiki/msg-doc
$msg
=
mw
.
message
(
key
,
name
,
label
).
parseDom
();
ve
.
targetLinksToNewWindow
(
$
(
'<div>'
).
append
(
$msg
)[
0
]
);
return
[
$msg
];
};
/**
* @private
* @param {boolean} [expand]
*/
ve
.
ui
.
MWAddParameterPage
.
prototype
.
togglePlaceholder
=
function
(
expand
)
{
this
.
isExpanded
=
expand
===
undefined
?
!
this
.
isExpanded
:
!!
expand
;
this
.
addParameterInputHeader
.
setIcon
(
this
.
isExpanded
?
'subtract'
:
'add'
);
this
.
addParameterFieldset
.
$element
.
toggleClass
(
've-ui-mwTransclusionDialog-addParameterFieldset-collapsed'
,
!
this
.
isExpanded
);
if
(
this
.
isExpanded
)
{
if
(
!
this
.
paramInputField
)
{
this
.
initialize
();
}
this
.
paramInputField
.
focus
();
}
};
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Sun, Nov 22, 05:35 (1 d, 2 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ae/22/b756b856eac3eb31a6b61b5039ad
Default Alt Text
ve.ui.MWAddParameterPage.js (6 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment