Class SingleTypeahead

java.lang.Object

org.patternfly.component.ComponentDelegate<HTMLElement, 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 ComponentDelegate<HTMLElement, 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.

This implementation uses the Popover API and CSS anchor positioning instead of Popper.js. The typeahead uses the browser's top-layer rendering for correct stacking, eliminating z-index issues. CSS position-try-fallbacks handles menu flipping when there is not enough space.

See Also:

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

Method Summary

Modifier and Type	Method	Description
SingleTypeahead	add(Menu menu)
SingleTypeahead	addMenu(Menu menu)
SingleTypeahead	allowNewItems(Function<String,String> prompt, Function<String, Promise<MenuItem>> createItem)	Allows the creation of new menu items based on user input.
SingleTypeahead	applyToMenuList(Consumer<MenuList> consumer)	Applies the provided Consumer to the MenuList associated with this SingleSelect.
SingleTypeahead	applyToMenuToggle(Consumer<MenuToggle> consumer)	Provides access to the underlying menu toggle using a fluent API style
SingleTypeahead	ariaLabel(String label)
void	attach(MutationRecord mutationRecord)
void	clear()
void	clear(boolean fireEvent)
void	collapse(boolean fireEvent)
void	detach(MutationRecord mutationRecord)
SingleTypeahead	disabled(boolean disabled)	Adds/removes modifier(disabled)
void	expand(boolean fireEvent)
boolean	isDisabled()
Menu	menu()
MenuToggle	menuToggle()
SingleTypeahead	noDefaultSelectHandler()
SingleTypeahead	onLoaded(ComponentHandler<SingleTypeahead> loadedHandler)
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.
SingleTypeahead	onToggle(ToggleHandler<SingleTypeahead> toggleHandler)
SingleTypeahead	placement(Placement placement)
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	stayOpen(StayOpenPredicate stayOpen)	Specifies a condition that determines whether the menu should remain open when the menu-toggle or the menu is clicked.
SingleTypeahead	that()

Methods inherited from class ComponentDelegate

componentType, element

Methods inherited from class Object

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

Methods inherited from interface ElementAttributeMethods

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

Methods inherited from interface ElementClassListMethods

classList, classList, css, toggle, toggle, toggle

Methods inherited from interface ElementConsumerMethods

apply, run

Methods inherited from interface ElementContainerMethods

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

Methods inherited from interface ElementEventMethods

on, on, on

Methods inherited from interface ElementIdMethods

id, uniqueId

Methods inherited from interface ElementQueryMethods

closest, querySelector, querySelectorAll

Methods inherited from interface Expandable

collapse, expand, expanded, toggle, toggle

Methods inherited from interface HTMLElementAttributeMethods

title

Methods inherited from interface HTMLElementDataMethods

data, data

Methods inherited from interface HTMLElementStyleMethods

style, style, style, style, style, style

Methods inherited from interface HTMLElementVisibilityMethods

hidden

Methods inherited from interface IsElement

element

Methods inherited from interface Modifiers.Disabled

disabled

Methods inherited from interface 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.

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 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.

applyToMenuList

public SingleTypeahead applyToMenuList(Consumer<MenuList> consumer)

Applies the provided Consumer to the MenuList associated with this SingleSelect. If the menu, menu content, or menu list is not yet initialized, they will be created as part of this method.

This method simplifies the process of adding menu items to the component. It is a shortcut for creating and adding a SingleSelectMenu, MenuContent, and MenuList in a single step. Don't use this method if you need to us another menu type, want to customize the menu, content or list or if you want to use MenuGroups.

Parameters:

consumer - a Consumer that accepts a MenuList for customization or modification

Returns:

the current SingleSelect instance for 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)

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

detach

public void detach(MutationRecord mutationRecord)

Specified by:

detach in interface Attachable

addMenu

public SingleTypeahead addMenu(Menu menu)

applyToMenuToggle

public SingleTypeahead applyToMenuToggle(Consumer<MenuToggle> consumer)

Provides access to the underlying menu toggle using a fluent API style

disabled

public SingleTypeahead disabled(boolean disabled)

Description copied from interface: Modifiers.Disabled

Adds/removes modifier(disabled)

Specified by:

disabled in interface Modifiers.Disabled<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

isDisabled

public boolean isDisabled()

Specified by:

isDisabled in interface Modifiers.Disabled<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

placement

public SingleTypeahead placement(Placement placement)

stayOpen

public SingleTypeahead stayOpen(StayOpenPredicate stayOpen)

Specifies a condition that determines whether the menu should remain open when the menu-toggle or the menu is clicked.

Parameters:

stayOpen - a Predicate that evaluates an Event to determine if the menu remains open.

Returns:

the current instance with the condition applied, enabling method chaining.

ariaLabel

public SingleTypeahead ariaLabel(String label)

onLoaded

public SingleTypeahead onLoaded(ComponentHandler<SingleTypeahead> loadedHandler)

onToggle

public SingleTypeahead onToggle(ToggleHandler<SingleTypeahead> toggleHandler)

collapse

public void collapse(boolean fireEvent)

Specified by:

collapse in interface Expandable<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

expand

public void expand(boolean fireEvent)

Specified by:

expand in interface Expandable<HTMLElement, B extends TypedBuilder<HTMLElement, B>>

menuToggle

public MenuToggle menuToggle()

menu

public Menu menu()