Class SingleTypeahead

java.lang.Object

org.patternfly.component.ComponentDelegate<HTMLElement, SingleTypeahead>

org.patternfly.component.menu.MenuToggleMenu<SingleTypeahead>

org.patternfly.component.menu.SingleTypeahead

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLElement, SingleTypeahead>, ElementClassListMethods<HTMLElement, SingleTypeahead>, ElementConsumerMethods<HTMLElement, SingleTypeahead>, ElementContainerMethods<HTMLElement, SingleTypeahead>, ElementEventMethods<HTMLElement, SingleTypeahead>, ElementIdMethods<HTMLElement, SingleTypeahead>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement, SingleTypeahead>, HTMLElementDataMethods<HTMLElement, SingleTypeahead>, HTMLElementStyleMethods<HTMLElement, SingleTypeahead>, HTMLElementVisibilityMethods<HTMLElement, SingleTypeahead>, IsElement<HTMLElement>, TypedBuilder<HTMLElement, SingleTypeahead>, Component, Expandable<HTMLElement, SingleTypeahead>, Typeahead<SingleTypeahead>, Modifiers.Disabled<HTMLElement, SingleTypeahead>

public class SingleTypeahead
extends MenuToggleMenu<SingleTypeahead>
implements Typeahead<SingleTypeahead>

A typeahead is a select variant that replaces the typical button toggle for opening the select menu with a text input and button toggle combo. As a user enters characters into the text input, the menu options will be filtered to match.

See Also:

• https://www.patternfly.org/components/menus/select

Method Summary

Modifier and Type	Method	Description
SingleTypeahead	add(Menu menu)
SingleTypeahead	allowNewItems(Function<String,String> prompt, Function<String, Promise<MenuItem>> createItem)	Allows the creation of new menu items based on user input.
void	clear()
void	clear(boolean fireEvent)
SingleTypeahead	noDefaultSelectHandler()
SingleTypeahead	onNoResults(NoResults noResults)	Configures the behavior for generating a "no results" menu item when no matching items are found in the menu list for the given input text.
SingleTypeahead	onSearch(SearchFilter searchFilter)	Configures the search behavior for this typeahead.
void	select(String identifier)
void	select(String identifier, boolean fireEvent)
void	select(MenuItem item)
void	select(MenuItem item, boolean fireEvent)
static SingleTypeahead	singleTypeahead(String id, String placeholder)	Creates a new SingleTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a SearchInput.
static SingleTypeahead	singleTypeahead(BaseSearchInput<?> searchInput)	Creates a new SingleTypeahead instance using the provided BaseSearchInput.
SingleTypeahead	that()

Methods inherited from class org.patternfly.component.menu.MenuToggleMenu

addMenu, applyTo, ariaLabel, attach, collapse, detach, disabled, expand, flip, isDisabled, menu, menuToggle, onLoaded, onToggle, placement, stayOpen, stayOpen, zIndex

Methods inherited from class org.patternfly.component.ComponentDelegate

componentType, element

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jboss.elemento.ElementAttributeMethods

aria, aria, aria, attr, attr, attr, role, role

Methods inherited from interface org.jboss.elemento.ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface org.jboss.elemento.ElementConsumerMethods

apply, run

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll

Methods inherited from interface org.jboss.elemento.ElementEventMethods

on, on, on

Methods inherited from interface org.jboss.elemento.ElementIdMethods

id, uniqueId

Methods inherited from interface org.jboss.elemento.ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface org.patternfly.component.Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface org.jboss.elemento.HTMLElementAttributeMethods

title

Methods inherited from interface org.jboss.elemento.HTMLElementDataMethods

data

Methods inherited from interface org.jboss.elemento.HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface org.jboss.elemento.HTMLElementVisibilityMethods

hidden

Methods inherited from interface org.jboss.elemento.IsElement

element

Methods inherited from interface org.patternfly.style.Modifiers.Disabled

disabled

Methods inherited from interface org.patternfly.component.menu.Typeahead

allowNewItems

Method Details

singleTypeahead

public static SingleTypeahead singleTypeahead(String id,
 String placeholder)

Creates a new SingleTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a SearchInput.

singleTypeahead

public static SingleTypeahead singleTypeahead(BaseSearchInput<?> searchInput)

Creates a new SingleTypeahead instance using the provided BaseSearchInput.

Parameters:

searchInput - the BaseSearchInput used to configure the typeahead component. This input determines the search behavior and the interaction model of the typeahead.

Returns:

a new SingleTypeahead instance initialized with a MenuToggle of type MenuToggleType.typeahead.

add

public SingleTypeahead add(Menu menu)

allowNewItems

public SingleTypeahead allowNewItems(Function<String,String> prompt,
 Function<String, Promise<MenuItem>> createItem)

Description copied from interface: Typeahead

Allows the creation of new menu items based on user input. This method enables a typeahead component to provide functionality for dynamically adding custom items when the user-provided input does not match any existing items.

Specified by:

allowNewItems in interface Typeahead<SingleTypeahead>

Parameters:

prompt - a Function that takes a String input representing the user's data and returns a String response, typically used to prompt the user or display a message.

createItem - a Function that takes a String input representing the user's data and returns a Promise of a MenuItem, representing the newly created item.

Returns:

an instance of the enclosing type, enabling method chaining for further configuration.

that

public SingleTypeahead that()

Specified by:

that in interface TypedBuilder<HTMLElement, SingleTypeahead>

onSearch

public SingleTypeahead onSearch(SearchFilter searchFilter)

Description copied from interface: Typeahead

Configures the search behavior for this typeahead.

Specified by:

onSearch in interface Typeahead<SingleTypeahead>

Parameters:

searchFilter - a SearchFilter that defines the search logic. The first parameter is a MenuItem representing a menu item, and the second parameter is a String representing the search query. The predicate should return true for items matching the search.

Returns:

the SingleTypeahead instance for method chaining.

onNoResults

public SingleTypeahead onNoResults(NoResults noResults)

Description copied from interface: Typeahead

Configures the behavior for generating a "no results" menu item when no matching items are found in the menu list for the given input text.

Specified by:

onNoResults in interface Typeahead<SingleTypeahead>

Parameters:

noResults - a NoResults implementation responsible for defining how the "no results" menu item is created and displayed when no matches are found.

Returns:

the instance of the current type enabling method chaining.

noDefaultSelectHandler

public SingleTypeahead noDefaultSelectHandler()

clear

public void clear()

clear

public void clear(boolean fireEvent)

select

public void select(String identifier)

select

public void select(String identifier,
 boolean fireEvent)

select

public void select(MenuItem item)

select

public void select(MenuItem item,
 boolean fireEvent)