Allow user to filter lists

[danrot]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Fixed tickets	fixes #4855
Related issues/PRs	---
License	MIT
Documentation PR	sulu/sulu-docs#prnum

What's in this PR?

This PR adds a new feature to filter list for values in certain columns.

Why?

Because we need that in quite a few projects.

Example Usage

BC Breaks/Deprecations

• The ListBuilderInterface has a new filter method

To Do

• Create a documentation PR
• Add breaking changes to UPGRADE.md
• Check if filters also work if they are not part of the selected fields
• Check if sortFields really need to be iterated over in findByIdsGivenCriteria method, because it seems to be done another time in assignSortFields
• Check if tagIds e.g. in contact.xml, webspaceKeys in target_groups.xml or tagIds in accounts.xml list configuration is possible. It is quite hard, because the ListBuilder builds a GROUP_CONCAT based on that field. The Selection filter type however would still work for 1:n relationships, but this one is n:m...
• Should filter work on trees? (mainly pages and categories)
• How to handle PHPCR content? (pages, snippets, custom-urls, analytics)
• Check if some filters should be removed because they don't make any sense
• MultiAutoComplete should take SelectionStore as argument to avoid multiple requests in SelectionFieldFilterType

Functional todos:

• Design of Chip component
• Where to place filter chips
• Positioning of buttons (search, column options and filter)
• Use auto-complete instead of MultiSelection
• Search on enter in text field and dates (?)
• Show value in chip
• Don't show value in chip before input has blurred, OK button has been pressed or whatever
• Dropdown for media (type, mimeType)?
• Return promise in getValueNode function to allow resolving of IDs for SelectionFieldFilterType?
• How to get old value (e.g. to merge object in DateFieldFilterType and NumberFieldFilterType
• Partial and exact match for TextFilterType
• Add filter information to URL in order to remember what has been selected after back button click
• Double requests when date filters are used
• Search button should also be left if no filters are available
• Excerpt returns tag ids as strings, causing a reaction to execute and trigger the save button immediately after opening the form
• SmartContent does not filter correctly when tags have already been stored before (sends the tag itself instead of the id in the items request for the form) (related to SmartContent - numeric Tags not working #4358?)

[lightglitch]

It's looking good. It's suppose to solve #4855?

[danrot]

@lightglitch Thank you for reminding me of that issue, yeah, this will be solved by this 🙂

[chirimoya]

@danrot Nice Job! Personally, I would prefer one-liners and a real Buttons. Also depends on the decision regarding the label.

• Store filter for user session
• Contact Birthday filter didn't work
• Contact Organization filter didn't work
• Media Type filter didn't work
• Missing filters for Snippets & Categories
• Date format changes... see screen shot

[niklasnatter]

i am not able to remove a boolean filter that is set to false if it was set to true before 🤔

[niklasnatter]

The following things should probably be addressed in another pr:

• selection filter looks broken if i select more than one entity (eg two different titles in contact list)
• dropdown popover of the dropdown filter covers the OK button when filtering meda types. i can only close it by clicking somewhere outside of the filter chip
• allow to select only a from date or a to date in the datetime filter (right now this leads to a failed request)

[niklasnatter]

Furthermore, i would propose the following usability improvements:

• close the filter chip with ESC
• confirm the filter chip with ENTER
• focus the text field automatically when i open a filter chip
• display the value of the number filter on the same line as the operator
• display a placeholder (eg with an example) in the text fields

[niklasnatter]

Apart from these small quirks, the functionality feels great and integrates beautifully into the UI. I think our users will really like this feature! 🙂

I would propose to merge this PR if the boolean filter bug is resolved and implement the other issues in another PR. Is this okay for you? @sulu/core-team ? would be nice to get this huge thing out of the way.

[danrot]

So to summarize:

• Removing a boolean filter does not work
• Selection filter looks broken if i select more than one entity (eg two different titles in contact list) (Adjust ArrowMenu to size changes of its children #5145)
• Dropdown popover of the dropdown filter covers the OK button when filtering meda types. i can only close it by clicking somewhere outside of the filter chip (Remove z-index values #5138)
• close the filter chip with ESC
• confirm the filter chip with ENTER
• focus the text field automatically when i open a filter chip (MultiAutoComplete, DateTime) (Focus elements in FieldFilterTypes where appropriate #5131)
• SelectionFieldFilterType mit einem MultiSelect als type (Add select type for SelectionFieldFilterType #5133)
• When filters had a value and the value has been removed by e.g. deleting the input value manually, the remove button does not work until a new value is added (Focus elements in FieldFilterTypes where appropriate #5131 (comment)) (Allow to remove undefined filter #5140)

[danrot]

The dropdown issue is (of course) a z-index issue... Don't know how to quickly fix that... I would love to get rid of all z-indexes all together, they always cause trouble at some point... I am checking the other issues right now, maybe I can fix one or the other before merging this PR, shouldn't be too bad.

[niklasnatter]

thank you! would be nice if confirming/closing the filter chip would work even if the input field is currently focused. i guess the problem here is something similar to #5054

anyway, a lot of things are working great and therefore i am happy to finally merge this 🙂