3 namespace MediaWiki\Widget
;
8 * @copyright 2011-2015 MediaWiki Widgets Team and others; see AUTHORS.txt
11 class SearchInputWidget
extends TitleInputWidget
{
13 protected $pushPending = false;
14 protected $performSearchOnClick = true;
15 protected $validateTitle = false;
16 protected $highlightFirst = false;
17 protected $dataLocation = 'header';
20 * @param array $config Configuration options
21 * - int|null $config['pushPending'] Whether the input should be visually marked as
22 * "pending", while requesting suggestions (default: false)
23 * - bool|null $config['performSearchOnClick'] If true, the script will start a search
24 * whenever a user hits a suggestion. If false, the text of the suggestion is inserted into
25 * the text field only (default: true)
26 * - string $config['dataLocation'] Where the search input field will be
27 * used (header or content, default: header)
29 public function __construct( array $config = [] ) {
30 $config = array_merge( [
35 parent
::__construct( $config );
37 // Properties, which are ignored in PHP and just shipped back to JS
38 if ( isset( $config['pushPending'] ) ) {
39 $this->pushPending
= $config['pushPending'];
42 if ( isset( $config['performSearchOnClick'] ) ) {
43 $this->performSearchOnClick
= $config['performSearchOnClick'];
46 if ( isset( $config['dataLocation'] ) ) {
47 // identifies the location of the search bar for tracking purposes
48 $this->dataLocation
= $config['dataLocation'];
52 $this->addClasses( [ 'mw-widget-searchInputWidget' ] );
55 protected function getInputElement( $config ) {
56 return ( new \OOUI\
Tag( 'input' ) )->setAttributes( [ 'type' => 'search' ] );
59 protected function getJavaScriptClassName() {
60 return 'mw.widgets.SearchInputWidget';
63 public function getConfig( &$config ) {
64 $config['pushPending'] = $this->pushPending
;
65 $config['performSearchOnClick'] = $this->performSearchOnClick
;
66 if ( $this->dataLocation
) {
67 $config['dataLocation'] = $this->dataLocation
;
69 $config['$overlay'] = true;
70 return parent
::getConfig( $config );