Package org.patternfly.component.menu

Class MenuSearch

java.lang.Object

org.patternfly.component.SubComponent<HTMLElement,MenuSearch>

org.patternfly.component.menu.MenuSearch

All Implemented Interfaces:

Attachable, ElementAttributeMethods<HTMLElement,MenuSearch>, ElementClassListMethods<HTMLElement,MenuSearch>, ElementConsumerMethods<HTMLElement,MenuSearch>, ElementContainerDelegate<HTMLElement,MenuSearch>, ElementContainerMethods<HTMLElement,MenuSearch>, ElementEventMethods<HTMLElement,MenuSearch>, ElementIdMethods<HTMLElement,MenuSearch>, ElementQueryMethods<HTMLElement>, HTMLElementAttributeMethods<HTMLElement,MenuSearch>, HTMLElementDataMethods<HTMLElement,MenuSearch>, HTMLElementStyleMethods<HTMLElement,MenuSearch>, HTMLElementVisibilityMethods<HTMLElement,MenuSearch>, IsElement<HTMLElement>, TypedBuilder<HTMLElement,MenuSearch>

public class MenuSearch
extends SubComponent<HTMLElement,MenuSearch>
implements Attachable, ElementContainerDelegate<HTMLElement,MenuSearch>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_COMPONENT_NAME

Method Summary

Modifier and Type	Method	Description
MenuSearch	addSearchInput(SearchInput searchInput)
void	attach(MutationRecord mutationRecord)
Element	containerDelegate()
static MenuSearch	menuSearch()
MenuSearch	onNoResults(Function<String,MenuItem> noResults)	Defines the behavior when no results are found during a search in the menu.
MenuSearch	onSearch(SearchFilter searchFilter)	Configures the search behavior for the search input you have added with addSearchInput(SearchInput).
MenuSearch	that()

Methods inherited from class org.patternfly.component.SubComponent

element, registerSubComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.elemento.Attachable

detach

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

add, add, add

Methods inherited from interface org.jboss.elemento.ElementContainerMethods

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

Field Details

SUB_COMPONENT_NAME

public static final String SUB_COMPONENT_NAME

See Also:

• Constant Field Values

Method Details

menuSearch

public static MenuSearch menuSearch()

containerDelegate

public Element containerDelegate()

Specified by:

containerDelegate in interface ElementContainerDelegate<HTMLElement,MenuSearch>

attach

public void attach(MutationRecord mutationRecord)

Specified by:

attach in interface Attachable

that

public MenuSearch that()

Specified by:

that in interface TypedBuilder<HTMLElement,MenuSearch>

addSearchInput

public MenuSearch addSearchInput(SearchInput searchInput)

onSearch

public MenuSearch onSearch(SearchFilter searchFilter)

Configures the search behavior for the search input you have added with addSearchInput(SearchInput).

By default, the search filter will match items that contain the search query in their text.

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 MenuSearch instance for method chaining.

onNoResults

public MenuSearch onNoResults(Function<String,MenuItem> noResults)

Defines the behavior when no results are found during a search in the menu. This method allows setting a Function that takes a search query as input and provides a MenuItem to be displayed when no matching results are found.

By default, a "No results found" message is displayed.

Parameters:

noResults - a Function that accepts a String parameter representing the search query, and returns a MenuItem to display for no results.

Returns:

the MenuSearch instance for method chaining.