The Search component is used for searching for specific content within an application.
Example
Provides text input optimized for search queries with built-in clear button.
code
<script type="module">
import '@blueprintui/components/include/search.js';
</script>
<bp-field>
<label>search</label>
<bp-search></bp-search>
</bp-field>Vertical
Demonstrates the search input in vertical form layout.
code
<bp-form-group layout="vertical">
<bp-field>
<label>label</label>
<bp-search></bp-search>
<bp-field-message>message text</bp-field-message>
</bp-field>
<bp-field>
<label>disabled</label>
<bp-search disabled></bp-search>
<bp-field-message>disabled message</bp-field-message>
</bp-field>
<bp-field status="error">
<label>error</label>
<bp-search></bp-search>
<bp-field-message status="error">error message</bp-field-message>
</bp-field>
<bp-field status="success">
<label>success</label>
<bp-search></bp-search>
<bp-field-message status="success">success message</bp-field-message>
</bp-field>
</bp-form-group>Horizontal
Demonstrates the search input in horizontal form layout.
code
<bp-form-group layout="horizontal">
<bp-field layout="horizontal">
<label>label</label>
<bp-search></bp-search>
<bp-field-message>message text</bp-field-message>
</bp-field>
<bp-field layout="horizontal">
<label>disabled</label>
<bp-search disabled></bp-search>
<bp-field-message>disabled message</bp-field-message>
</bp-field>
<bp-field layout="horizontal" status="error">
<label>error</label>
<bp-search></bp-search>
<bp-field-message status="error">error message</bp-field-message>
</bp-field>
<bp-field layout="horizontal" status="success">
<label>success</label>
<bp-search></bp-search>
<bp-field-message status="success">success message</bp-field-message>
</bp-field>
</bp-form-group>Compact
Demonstrates the search input in compact form layout.
code
<bp-form-group layout="compact">
<bp-field layout="compact">
<label>label</label>
<bp-search></bp-search>
<bp-field-message>message text</bp-field-message>
</bp-field>
<bp-field layout="compact">
<label>disabled</label>
<bp-search disabled></bp-search>
<bp-field-message>disabled message</bp-field-message>
</bp-field>
<bp-field layout="compact" status="error">
<label>error</label>
<bp-search></bp-search>
<bp-field-message status="error">error message</bp-field-message>
</bp-field>
<bp-field layout="compact" status="success">
<label>success</label>
<bp-search></bp-search>
<bp-field-message status="success">success message</bp-field-message>
</bp-field>
</bp-form-group>Install
NPM
// npm package
import '@blueprintui/components/include/search.js';CDN
<script type="module">
import 'https://cdn.jsdelivr.net/npm/@blueprintui/components/include/search.js/+esm';
</script>Accessibility
- The search component should have an accessible label or
aria-labelattribute if no visible label is present. - The search component should support keyboard-triggered actions, such as submitting the search query when the "Enter" key is pressed.
- The search component should provide clear feedback to users when their input is invalid, such as providing an error message or visual indication.
bp-search
Events
| Name | Types | Description |
|---|---|---|
input | InputEvent | occurs when the value changes |
change | InputEvent | occurs when the value changes |
Properties
| Name | Types | Description |
|---|---|---|
type | string | Specifies the input type as search for optimized search behavior |
Attributes
| Name | Types | Description |
|---|---|---|
type | string | Specifies the input type as search for optimized search behavior |
CSS Properties
| Name | Types | Description |
|---|---|---|
--background-size | ||
--color | ||
--background | ||
--border | ||
--border-radius | ||
--outline | ||
--outline-offset | ||
--padding | ||
--font-size | ||
--line-height | ||
--height | ||
--min-width | ||
--width | ||
--transition | ||
--text-align | ||
--cursor |
Slots
| Name | Types | Description |
|---|---|---|
prefix | slot for prefix text or icons | |
suffix | slot for suffic text or icons |