Class MultiTypeahead

java.lang.Object

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

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

org.patternfly.component.menu.MultiTypeahead

All Implemented Interfaces:

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

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

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
MultiTypeahead	add(Menu menu)
MultiTypeahead	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)
static MultiTypeahead	multiTypeahead(String id, String placeholder)	Creates a new MultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a FilterInput.
static MultiTypeahead	multiTypeahead(BaseFilterInput<?> filterInput)	Creates a new MultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and the specified BaseFilterInput.
MultiTypeahead	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.
MultiTypeahead	onSearch(SearchFilter searchFilter)	Configures the search behavior for this typeahead.
void	selectIdentifiers(List<String> identifiers)
void	selectIdentifiers(List<String> identifiers, boolean fireEvent)
void	selectItems(List<MenuItem> items)
void	selectItems(List<MenuItem> items, boolean fireEvent)
MultiTypeahead	that()

Methods inherited from class MenuToggleMenu

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

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

multiTypeahead

public static MultiTypeahead multiTypeahead(String id,
 String placeholder)

Creates a new MultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and a FilterInput.

multiTypeahead

public static MultiTypeahead multiTypeahead(BaseFilterInput<?> filterInput)

Creates a new MultiTypeahead component with a MenuToggle of type MenuToggleType.typeahead and the specified BaseFilterInput.

Parameters:

filterInput - the BaseFilterInput instance used to configure the typeahead component with filtering and search capabilities

Returns:

a new MultiTypeahead instance configured with the given filter input

add

public MultiTypeahead add(Menu menu)

allowNewItems

public MultiTypeahead 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<MultiTypeahead>

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 MultiTypeahead that()

Specified by:

that in interface TypedBuilder<HTMLElement, MultiTypeahead>

onSearch

public MultiTypeahead onSearch(SearchFilter searchFilter)

Description copied from interface: Typeahead

Configures the search behavior for this typeahead.

Specified by:

onSearch in interface Typeahead<MultiTypeahead>

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

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.

clear

public void clear()

clear

public void clear(boolean fireEvent)

selectIdentifiers

public void selectIdentifiers(List<String> identifiers)

selectIdentifiers

public void selectIdentifiers(List<String> identifiers,
 boolean fireEvent)

selectItems

public void selectItems(List<MenuItem> items)

selectItems

public void selectItems(List<MenuItem> items,
 boolean fireEvent)