Reintroduce section sorting to the roomlist #30887
Conversation
github-actions
bot
added
the
Z-Community-PR
justjanne
force-pushed
the
labs/roomlist-sections
branch
from
77a1f19 to
054eff7
Compare
justjanne
force-pushed
the
labs/roomlist-sections
branch
2 times, most recently
from
dfebcfe to
438dfd2
Compare
justjanne
force-pushed
the
labs/roomlist-sections
branch
from
438dfd2 to
77a7960
Compare
justjanne
force-pushed
the
labs/roomlist-sections
branch
from
77a7960 to
cf86efe
Compare
justjanne
force-pushed
the
labs/roomlist-sections
branch
from
cf86efe to
2a1c74b
Compare
This comment was marked as outdated.
This comment was marked as outdated.
justjanne
force-pushed
the
labs/roomlist-sections
branch
from
8382cfc to
f9b6eeb
Compare
|
justjanne
force-pushed
the
labs/roomlist-sections
branch
from
f9b6eeb to
d7bb3cc
Compare
|
I've been trying this out today and it seems a real improvement. For me to be able to use this instead of my current hack, I'd just need "unread" to mean "unread" i.e. rooms with a dot instead of whatever it means now :-). |
This comment was marked as resolved.
This comment was marked as resolved.
justjanne
force-pushed
the
labs/roomlist-sections
branch
from
d7bb3cc to
b1898d5
Compare
|
The conclusion of the investigation regarding the unread filter is that we'll stick with the current implementation, which uses the Unread filter of the new room list. |
|
I've decided not to implement section headers for now, to unblock the rest of this PR for now. |
| "sort_by": "Sort by", | ||
| "sort_by_activity": "Activity", | ||
| "sort_by_alphabet": "A-Z", | ||
| "sort_sections": "Group rooms by type", |
There was a problem hiding this comment.
Feel free to suggest a better alternative, as long as we don't have section headers, "Sort rooms by type" might make more sense anyway.
| * A string that uniquely identifies this given sorter. | ||
| */ | ||
| type: SortingAlgorithm; | ||
| type: string; |
There was a problem hiding this comment.
As this is used by the RoomList and RoomSkipList to determine whether the sorter has changed – basically like a hash over the sorter's properties – this must uniquely identify all properties of the current sorter.
Therefore I had to change it to string, to be able to represent the added properties of the SectionSorter.
| import type { Sorter } from "."; | ||
| import { buildSections, type Section, sectionMatches } from "../sections"; | ||
|
|
||
| export class SectionSorter implements Sorter { |
There was a problem hiding this comment.
Basically, this sorter uses roomlist filters to group rooms into sections, and then uses another sorter within each section.
A room is considered part of a section if it matches ALL filters of that section. If a room matches no other section, it is sorted into the null section.
| [FilterKey.LowPriorityFilter]: new LowPriorityFilter(), | ||
| }; | ||
|
|
||
| export function sectionMatches(section: Section, room: Room): boolean { |
There was a problem hiding this comment.
A room matches a section if it matches every filter of that section. The null/"Other" section matches no room, it is handled separately to allow other sections to appear after it.
|
Hi Janne! Thanks for the contribution, I'm taking a look into this. Thanks for your patience with me! |
In Short
This PR allows sorting the room list into sections, similar to the functionality of the old room list.
Until this gets merged, I'll maintain
k8r.eu/justjanne/element-web:v1.12.0k8r.eu/justjanne/element-web:developRationale
Many group chat apps section their room list, e.g. Slack with Rooms and DMs, Discord with Rooms and Voice/Video rooms. As I heavily rely on this feature every day, I decided to port it.
Limitations
This will not allow custom sorting methods per section, nor collapsible sections. All it does is change the sorting order to sort certain sections first. I'm planning to add section headers as well, but I haven't fully brainstormed how that'd work yet.
Checklist
public/exportedsymbols have accurate TSDoc documentation.