menuFilterField 菜单过滤器

menuFilterField 组件对通过菜单的文本对主菜单项进行过滤。

XML 元素

menuFilterField

Java 类

MenuFilterField

概览

Menu filter field

基本用法

将 menuFilterField 放在主视图中，并设置 menu 属性为需要过滤的 listMenu 的 ID。当用户输入时，组件根据配置的 filterMode 对菜单项进行过滤：

<menuFilterField placeholder="Search..."
                 classNames="ms-s me-s"
                 menu="menu"/> (1)
<nav id="navigation"
     classNames="jmix-main-view-navigation"
     ariaLabel="msg://navigation.ariaLabel">
    <listMenu id="menu"/>
</nav>
1 指向 listMenu 组件，提供需要过滤的菜单。
目前暂不支持对 horizontalMenu 进行过滤。

样式版本

使用 themeNames 属性配置一个或多个样式。

样式 描述 支持的主题

align-left

字段值左对齐。

Aura, Lumo

align-center

字段值居中对齐。

Aura, Lumo

align-right

字段值右对齐。

Aura, Lumo

align-start

根据当前文本方向，将字段值向起始侧对齐。

Aura

align-end

根据当前文本方向，将字段值向末尾侧对齐。

Aura

helper-above-field

帮助文字显示在字段上方，标题下方。

Aura, Lumo

small

组件更小。

Aura, Lumo

XML 属性

下面是 menuFilterField 的特殊属性：

名称 描述 默认值

filterMode

匹配时是否大小写敏感。

CASE_INSENSITIVE

menu

指向需要通过 listMenu 过滤的菜单。

—

clearButtonVisible

是否显示一个清除当前值的按钮。

false

autoselect

当输入组件获得焦点时，是否自动选中内容。

false

下面是 menuFilterField 支持的其他通用属性：

id - label - placeholder - helperText - value - autofocus - readOnly - enabled - valueChangeMode - valueChangeTimeout - focusShortcut - tabIndex - themeNames - visible - width - height - minWidth - maxWidth - minHeight - maxHeight - alignSelf - colspan - classNames - css - ariaLabel - ariaLabelledBy - title

事件和处理器

下面是 menuFilterField 支持的通用事件：

AttachEvent - DetachEvent - InputEvent - KeyDownEvent - KeyPressEvent - KeyUpEvent - BlurEvent - FocusEvent