ons-search-input

A search input element. The component will automatically render as a Material Design search input on Android devices. Most attributes that can be used for a normal <input> element can also be used on the <ons-search-input> element.

Tutorial

Search input

Even though ons-input supports type="search", Onsen UI provides an extra element ons-search-input that styles the input as a real search bar:

<ons-search-input placeholder="Search something"></ons-search-input>

As usual, any attribute for <input> element works for the search input (except type which is fixed to search).

Inner input element

For normal input elements is possible to define a <label> tab with the for attribute to link it to an input element.

Unfortunately this does not work with custom elements like <ons-label> so in order to do it we need to set the id attribute of the inner input element. This is done using the input-id attribute.

<label for="username">Username</label>
<ons-input input-id="username"></ons-input>

This work with any input in Onsen UI such as checkboxes, radios, etc.

See also

Attributes

Attributes are added directly to the element. You can do this in HTML or JS.

HTML: <ons-search-input someAttribute="true" anotherAttribute><ons-search-input>
JS: document.querySelector('ons-search-input').setAttribute('someAttribute', 'true')

Name Type Description
input-id String Specify the “id” attribute of the inner <input> element. This is useful when using <label for="..."> elements. Optional.

Properties

Properties are accessed on the element through JS, and should be get and set directly. For example: document.querySelector('ons-search-input').value.

Name Description
value The current value of the input.
disabled Whether the input is disabled or not.

Preset Modifiers

Modifiers are set in the modifier attribute. To use more than one, separate them by spaces. For example:
<ons-search-input modifier="material modifier2"><ons-search-input>.

Name Description
material Displays a Material Design search input.

Need Help?

If you have any questions, use our Community Forum or talk to us on Discord chat. The Onsen UI team and your peers in the community will work together to help solve your issues.

For bug reports and feature requests use our GitHub Issues page.