Package org.patternfly.component.textinputgroup
package org.patternfly.component.textinputgroup
Provides text input group components for search, filter, and text input with utilities.
A text input group is an input component with additional capabilities such as icons, search utilities (clear button), and filter labels. This package includes a base text input group, a search input with built-in clear functionality, and a filter input that supports adding and removing filter labels.
Key Classes
TextInputGroup- Base text input groupSearchInputGroup- Text input with search and clear utilitiesSearchInputGroupTypeahead- Search input with typeahead/autocomplete menuFilterInputGroup- Text input with filter label managementFilterInputGroupTypeahead- Filter input with typeahead/autocomplete menuTextInputGroupUtilities- Utility buttons (clear, etc.)
Usage
Create a basic text input group or a search input with an icon:
import static org.patternfly.component.textinputgroup.SearchInputGroup.searchInputGroup;
import static org.patternfly.component.textinputgroup.TextInputGroup.textInputGroup;
import static org.patternfly.icon.IconSets.rhUi.search;
// Basic text input group
TextInputGroup basic = textInputGroup("my-input");
// Disabled text input group
TextInputGroup disabled = textInputGroup("disabled-input", "Disabled").disabled();
// Search input with icon
SearchInputGroup searchInput = searchInputGroup("search-0").icon(search());
Create a filter input with label management:
import static org.patternfly.component.textinputgroup.FilterInputGroup.filterInputGroup;
import static org.patternfly.icon.IconSets.rhUi.search;
FilterInputGroup filterInput = filterInputGroup("filter-0").icon(search())
.allowDuplicates(false)
.onAdd((fi, filter) -> console.log("Filter added: " + filter.text()))
.onRemove((fi, filter) -> console.log("Filter removed: " + filter.text()));
- See Also:
-
ClassesClassDescriptionBaseFilterInputGroup<T extends BaseFilterInputGroup<T>>Base class for filter input components within a
TextInputGroup.BaseSearchInputGroup<T extends BaseSearchInputGroup<T>>Base class for search input components within aTextInputGroup.BaseTextInputGroup<T extends BaseTextInputGroup<T>>Base class for text input group components.A filter input is a special search input that adds a label group.A filter input with typeahead/autocomplete support.A search input is a special text input group that adds a clear utility button.A search input with typeahead/autocomplete support.A text input group is a more flexible composable version of a text input.A container for utility elements in aTextInputGroupcomponent.