Class MenuSearch

java.lang.Object
org.patternfly.component.SubComponent<elemental2.dom.HTMLElement, MenuSearch>
org.patternfly.component.menu.MenuSearch
All Implemented Interfaces:
Attachable, ElementAttributeMethods<elemental2.dom.HTMLElement, MenuSearch>, ElementClassListMethods<elemental2.dom.HTMLElement, MenuSearch>, ElementConsumerMethods<elemental2.dom.HTMLElement, MenuSearch>, ElementContainerDelegate<elemental2.dom.HTMLElement, MenuSearch>, ElementContainerMethods<elemental2.dom.HTMLElement, MenuSearch>, ElementEventMethods<elemental2.dom.HTMLElement, MenuSearch>, ElementIdMethods<elemental2.dom.HTMLElement, MenuSearch>, ElementQueryMethods<elemental2.dom.HTMLElement>, HTMLElementAttributeMethods<elemental2.dom.HTMLElement, MenuSearch>, HTMLElementDataMethods<elemental2.dom.HTMLElement, MenuSearch>, HTMLElementStyleMethods<elemental2.dom.HTMLElement, MenuSearch>, HTMLElementVisibilityMethods<elemental2.dom.HTMLElement, MenuSearch>, IsElement<elemental2.dom.HTMLElement>, TypedBuilder<elemental2.dom.HTMLElement, MenuSearch>, OuiaSupport<elemental2.dom.HTMLElement, MenuSearch>
public class MenuSearch extends SubComponent<elemental2.dom.HTMLElement, MenuSearch> implements Attachable, ElementContainerDelegate<elemental2.dom.HTMLElement, MenuSearch>
A search input within a Menu component.

  • Field Details

  • Method Details

    • containerDelegate

      public elemental2.dom.Element containerDelegate()
      Specified by:
      containerDelegate in interface ElementContainerDelegate<elemental2.dom.HTMLElement, MenuSearch>

    • attach

      public void attach(elemental2.dom.MutationRecord mutationRecord)
      Specified by:
      attach in interface Attachable

    • addSearchInput

      public MenuSearch addSearchInput(SearchInputGroup searchInput)

    • that

      public MenuSearch that()
      Specified by:
      that in interface TypedBuilder<elemental2.dom.HTMLElement, MenuSearch>

    • onSearch

      public MenuSearch onSearch(SearchFilter searchFilter)
      Configures the search behavior for the search input you have added with addSearchInput(SearchInputGroup).

      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(NoResults noResults)
      Configures the behavior for handling the event when no results are found in the menu list for a given input.
      Parameters:
      noResults - a NoResults functional interface instance that defines the logic to generate a menu item when no results are found for the search query.
      Returns:
      the MenuSearch instance for method chaining.