Skip to content

FilterForm

Overview

Renders the body of a filter popover for a single filterable field. It displays a heading, the appropriate field widget via FieldRenderer, and an Apply button that submits the filter value back to the parent FilterFieldForm.

Theme entry: FilterForm

Props

NameTypeRequiredDefaultDescription
themeOverrideString|Object|ArraynullA partial theme object merged with the component's default theme; accepts a class string, class array, or theme object.
filterNamestringyesField name this form filters on, used to look up the field renderer and slot names.
filterLabelstringyesHuman-readable label displayed in the form heading.
applyFilterfuncyesCallback invoked when the user submits the filter form.
hasFilterValuebooleanfalseWhen true, indicates an active filter value is set for this field.

Slots

NameScopedDescription
filter-form-headeryesHeader area at the top of the filter form.
filter-form-submit-buttonyesSubmit button for the filter form.

Full slot reference

Source

client/lib/form/filter/FilterForm.vue

Documents matching: server v3.0.0a1.post1client v3.0.0-alpha.2