SearchInput ​

A SearchInput allows users to enter and submit a search query.

Guidelines ​

Using search inputs ​

Use the SearchInput component when you need users to perform text-based searches for specific content, like finding results on a page.

Avoid using SearchInput if you require a predictive list of options in a menu while users type within the input field. In such cases, use TypeaheadSearch instead.

Avoid using SearchInput to enable users to search a dataset of options for a form field. Instead, use Lookup.

Specifications ​

Search inputs may include the following elements:

1. Input
   A text input where users can type their search queries. The input features the 'search' icon for clarity and should also include a placeholder to clarify its purpose.
2. Button (optional)
   The input can be accompanied with a button, either a text button or an icon-only one, in order to trigger the search action. It's crucial not to customize the label of the search button and consistently employ the term "Search" or its appropriate translation. Additionally, avoid using long text within this button.

Types ​

The SearchInput component can be categorized based on the visibility and type of button it contains:

Without button ​

The SearchInput can consist of the input field alone or include the decorative icon. In this scenario, using the icon is suggested to emphasize that the input serves as a search input, distinguishing it from a simple text input.

With text button ​

The SearchInput also has the option to feature a text button to initiate the search process.

With icon-only button ​

The SearchInput can also include an icon-only button, particularly useful when space needs to be conserved by omitting the button text, such as on mobile devices. In such instances, since the 'search' icon will already be present on the button, there's no need to replicate it within the input. In this case, refrain from using an icon within the input field to avoid duplication with the icon in the button.

Interaction states ​

Search inputs have the following visually separate states:

1. Default
2. Hover
3. Active - Focus
4. Filled

Demos ​

Open the console to see emitted events.

Default, with placeholder ​

The placeholder attribute will be passed down to the <input> element.

<template>
	<div>
		<cdx-search-input
			v-model="inputValue"
			aria-label="SearchInput default demo"
			placeholder="Search"
			@update:model-value="onUpdateModelValue"
		/>
	</div>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxSearchInput } from '@wikimedia/codex';

export default defineComponent( {
	name: 'SearchInputDefault',
	components: { CdxSearchInput },
	setup() {
		// Set up a reactive reference to track the input value.
		const inputValue = ref( '' );

		const onUpdateModelValue = function ( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value: ' + value );
		};

		return {
			inputValue,
			onUpdateModelValue
		};
	}
} );
</script>

<template>
	<div>
		<cdx-search-input
			v-model="inputValue"
			aria-label="SearchInput default demo"
			placeholder="Search"
			@update:model-value="onUpdateModelValue"
		></cdx-search-input>
	</div>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxSearchInput } = require( '@wikimedia/codex' );

// @vue/component
module.exports = defineComponent( {
	name: 'SearchInputDefault',
	components: { CdxSearchInput },
	setup() {
		// Set up a reactive reference to track the input value.
		const inputValue = ref( '' );

		const onUpdateModelValue = function ( value ) {
			// eslint-disable-next-line no-console
			console.log( 'update:modelValue event emitted with value: ' + value );
		};

		return {
			inputValue,
			onUpdateModelValue
		};
	}
} );
</script>

Reading direction

With button ​

This example provides a buttonLabel prop, which enables the submit button.

<template>
	<div>
		<cdx-search-input
			v-model="inputValue"
			button-label="Search"
			aria-label="SearchInput with Button demo"
			@update:model-value="onEvent( 'update:modelValue', $event )"
			@submit-click="onEvent( 'submit-click', $event )"
		/>
	</div>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxSearchInput } from '@wikimedia/codex';

export default defineComponent( {
	name: 'SearchInputWithButton',
	components: { CdxSearchInput },
	setup() {
		// Set up a reactive reference to track the input value.
		const inputValue = ref( '' );

		/**
		 * @param {string} eventName
		 * @param {string} value
		 */
		const onEvent = function ( eventName, value ) {
			// eslint-disable-next-line no-console
			console.log( eventName + ' event emitted with value: ' + value );
		};

		return {
			inputValue,
			onEvent
		};
	}
} );
</script>

<template>
	<div>
		<cdx-search-input
			v-model="inputValue"
			button-label="Search"
			aria-label="SearchInput with Button demo"
			@update:model-value="onEvent( 'update:modelValue', $event )"
			@submit-click="onEvent( 'submit-click', $event )"
		></cdx-search-input>
	</div>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxSearchInput } = require( '@wikimedia/codex' );

// @vue/component
module.exports = defineComponent( {
	name: 'SearchInputWithButton',
	components: { CdxSearchInput },
	setup() {
		// Set up a reactive reference to track the input value.
		const inputValue = ref( '' );

		/**
		 * @param {string} eventName
		 * @param {string} value
		 */
		const onEvent = function ( eventName, value ) {
			// eslint-disable-next-line no-console
			console.log( eventName + ' event emitted with value: ' + value );
		};

		return {
			inputValue,
			onEvent
		};
	}
} );
</script>

Clearable ​

The clearable prop from the TextInput component adds a "clear" button when input is present.

<template>
	<div>
		<cdx-search-input
			v-model="inputValue"
			button-label="Search"
			:clearable="true"
			aria-label="SearchInput clearable demo"
			@update:model-value="onEvent( 'update:modelValue', $event )"
			@submit-click="onEvent( 'submit-click', $event )"
		/>
	</div>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxSearchInput } from '@wikimedia/codex';

export default defineComponent( {
	name: 'SearchInputClearable',
	components: { CdxSearchInput },
	setup() {
		// Set up a reactive reference to track the input value.
		const inputValue = ref( '' );

		/**
		 * @param {string} eventName
		 * @param {string} value
		 */
		const onEvent = function ( eventName, value ) {
			// eslint-disable-next-line no-console
			console.log( eventName + ' event emitted with value: ' + value );
		};

		return {
			inputValue,
			onEvent
		};
	}
} );
</script>

<template>
	<div>
		<cdx-search-input
			v-model="inputValue"
			button-label="Search"
			:clearable="true"
			aria-label="SearchInput clearable demo"
			@update:model-value="onEvent( 'update:modelValue', $event )"
			@submit-click="onEvent( 'submit-click', $event )"
		></cdx-search-input>
	</div>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxSearchInput } = require( '@wikimedia/codex' );

// @vue/component
module.exports = defineComponent( {
	name: 'SearchInputClearable',
	components: { CdxSearchInput },
	setup() {
		// Set up a reactive reference to track the input value.
		const inputValue = ref( '' );

		/**
		 * @param {string} eventName
		 * @param {string} value
		 */
		const onEvent = function ( eventName, value ) {
			// eslint-disable-next-line no-console
			console.log( eventName + ' event emitted with value: ' + value );
		};

		return {
			inputValue,
			onEvent
		};
	}
} );
</script>

Form field ​

A SearchInput can be wrapped in the Field component to add features like a semantic label, description and help text, validation messages, and more. See the Field page for more information.

<template>
	<cdx-field>
		<cdx-search-input
			v-model="inputValue"
			button-label="Search"
		/>
		<template #label>
			Search articles
		</template>
		<template #description>
			Find Wikipedia articles
		</template>
		<template #help-text>
			If there is an article matching your search term, you will be taken directly to that
			article. Otherwise, you will be taken to the search page.
		</template>
	</cdx-field>
</template>

<script>
import { defineComponent, ref } from 'vue';
import { CdxSearchInput, CdxField } from '@wikimedia/codex';

export default defineComponent( {
	name: 'SearchInputField',
	components: { CdxSearchInput, CdxField },
	setup() {
		const inputValue = ref( '' );

		return {
			inputValue
		};
	}
} );
</script>

<template>
	<cdx-field>
		<cdx-search-input
			v-model="inputValue"
			button-label="Search"
		></cdx-search-input>
		<template #label>
			Search articles
		</template>
		<template #description>
			Find Wikipedia articles
		</template>
		<template #help-text>
			If there is an article matching your search term, you will be taken directly to that
			article. Otherwise, you will be taken to the search page.
		</template>
	</cdx-field>
</template>

<script>
const { defineComponent, ref } = require( 'vue' );
const { CdxSearchInput, CdxField } = require( '@wikimedia/codex' );

// @vue/component
module.exports = defineComponent( {
	name: 'SearchInputField',
	components: { CdxSearchInput, CdxField },
	setup() {
		const inputValue = ref( '' );

		return {
			inputValue
		};
	}
} );
</script>

Vue usage ​

This component contains a TextInput with a preset start icon and input type. A button can be added by providing the buttonLabel prop.

The default slot allows you to pass in an options menu that can be absolutely positioned to line up with the text input, e.g. a list of autocomplete options. See TypeaheadSearch for an example.

Props ​

Methods ​

Events ​

Slots ​

CSS-only version ​

Markup structure ​

The basic CSS-only SearchInput component is a CSS-only TextInput with type="search" and a start icon, wrapped in a <div> with the CSS class .cdx-search-input. The CSS-only search icon is set up for you, so you do not need to include it in your Less code.

<!-- Wrapper div. -->
<div class="cdx-search-input">
  <!-- CSS-only TextInput with start icon. -->
  <div class="cdx-text-input cdx-text-input--has-start-icon">
    <!-- Input with type="search". -->
    <input class="cdx-text-input__input" type="search" placeholder="Search" />
    <!-- Start icon span. -->
    <span class="cdx-text-input__icon cdx-text-input__start-icon"></span>
  </div>
</div>

With button ​

To add a button to the CSS-only SearchInput, do the following:

• Add the .cdx-search-input--has-end-button class to the root element
• Wrap the CSS-only TextInput component in a div with the class .cdx-search-input__input-wrapper
• Add a CSS-only button with the classes .cdx-button and .cdx-search-input__end-button

<div class="cdx-search-input cdx-search-input--has-end-button">
  <div class="cdx-search-input__input-wrapper">
    <div class="cdx-text-input cdx-text-input--has-start-icon">
      <input class="cdx-text-input__input" type="search" placeholder="Search" />
      <span class="cdx-text-input__icon cdx-text-input__start-icon"></span>
    </div>
  </div>
  <button class="cdx-button cdx-search-input__end-button">Search</button>
</div>