Skip to content

FilterMenu ​

Overview ​

Toolbar entry point for adding filters. The trigger opens a menu listing the fields not yet applied (a popover on desktop, a full-screen dialog on mobile, via ResponsiveMenu); picking one drills the menu in place to that field's FilterFieldForm, with a back affordance returning to the list. The trigger teleports into a toolbar zone supplied by the host view.

Theme entry: FilterMenu

Props ​

NameTypeRequiredDefaultDescription
iconOverrideObjectnullA partial icon registry ({ [componentName]: { [iconName]: { component, props } } }) merged with inherited and default icon entries; scopes icon overrides to this component and its descendants.
themeOverrideObjectnullA partial ThemeObject keyed by component name, merged over this component's theme and provided to descendants.
filterablesarray[]Filterable field names to offer: non-hidden fields the client can render an editable input for (e.g. useViewList's filter.validFilterables).
filterableDetailsobject{}Per-field filter configuration, keyed by field name.
queryobject{}Current URL query, forwarded to the drill-in form.
triggerTargetobject|stringnullElement (or selector) the trigger teleports into. When falsy, the trigger renders in place.
labelstring"Filters"Trigger label text.

Slots ​

slot ​

Scoped slot.

Events ​

hide-filter-form ​

Source ​

client/lib/form/filter/FilterMenu.vue