feat: sort favorite contact first in list by GretaD · Pull Request #5251 · nextcloud/contacts

GretaD · 2026-04-10T11:38:59Z

Fixes #105

Requires feat: Add custom favorite property for each vCard cdav-library#1029 merged, and released
Requires cdav lib update

How to test

You need to link cdav-library with contacts while in this pr: nextcloud/cdav-library#1029

codecov · 2026-04-10T11:40:23Z

Codecov Report

❌ Patch coverage is 0% with 105 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/store/contacts.js	0.00%	46 Missing and 22 partials ⚠️
src/components/ContactsList/ContactsListItem.vue	0.00%	30 Missing ⚠️
src/models/contact.js	0.00%	4 Missing and 3 partials ⚠️

📢 Thoughts on this report? Let us know!

ChristophWurst · 2026-05-06T08:06:50Z

Cleaned-up the PR description so it's clear that we can not merge this before the cdav merge, release and update here

GVodyanov

Tested it and works great!

Just a few styling comments, will approve to not block.

I also noted that there is the age old issue representing itself (at least to me in firefox)

Right after favouriting u get the star stuck on the side of the component until you hover over it, but that's almost more of a vue or browser bug probably, I had this on other PRs too and wasn't able to fix it.

DerDreschner

For me, the sorting is... strange?

simplescreenrecorder-2026-05-06_15.14.52.mp4

And when I open a contact, the favorite status is being lost as it's only included in the PROPFIND for the address book by the cdav-library right now, not the contact itself. Could you have a look?

If necessary, I can modify the cdav-library to retrieve the favorite property as well. But as there is no star indicator on the contact itself, only the contacts list, I see no reason for retrieving it there as well.

DerDreschner

Retested and the sorting is now correct! 😄 Only two things that can be fixed in follow-ups:

When selecting a contact marked as favorite, the contact list jumps unexpectedly so the selected contact is on the top for some reason:

simplescreenrecorder-2026-05-07_14.55.00.mp4

Hiding the star for address books that don't have the {DAV:}write-properties right (see nextcloud/server#60183 (comment))

hamza221

IMO the button shouldn't show for readonly contacts

ChristophWurst · 2026-05-07T15:09:28Z

Read-only is fine. We want the feature to be usable for the SAB and for read-only shared ABs. It should only not be usable for the recently contacted, because that data is volatile.

hamza221 · 2026-05-07T15:17:43Z

Read-only is fine. We want the feature to be usable for the SAB and for read-only shared ABs. It should only not be usable for the recently contacted, because that data is volatile.

So it's supposed to work for SAB cards ?
I'll test again cause it didn't work when testing

hamza221 · 2026-05-08T10:05:30Z

+		async toggleFavorite() {
+			const contact = this.$store.getters.getContact(this.source.key)
+			if (!contact) {
+				console.error('Could not find contact in store', this.source.key)


all console.error should be logger.error instead

hamza221 · 2026-05-08T10:09:23Z

Read-only is fine. We want the feature to be usable for the SAB and for read-only shared ABs. It should only not be usable for the recently contacted, because that data is volatile.

So it's supposed to work for SAB cards ? I'll test again cause it didn't work when testing

Works fine btw 👏🏼

Copilot

Pull request overview

This PR adds “favorite contact” support to the Contacts frontend so favorites can be toggled from the list UI and are sorted to the top of contact lists.

Changes:

Add favorite-aware sorting and a toggleFavorite Vuex action/mutation flow in the contacts store.
Add a favorite getter/setter on the Contact model backed by contact.dav.favorite.
Add a favorites toggle control (star) to each contact list item, plus an action menu entry.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 8 comments.

File	Description
`src/store/contacts.js`	Introduces favorite-aware sorting, store mutation/action to toggle favorites, and preserves favorite metadata across fetch/update flows.
`src/models/contact.js`	Adds `favorite` getter/setter that proxies to the DAV layer.
`src/components/ContactsList/ContactsListItem.vue`	Adds UI controls (star + action button) to toggle favorite state from the contact list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

 			for (let i = 0, len = state.sortedContacts.length; i < len; i++) {
-				if (sortData(state.sortedContacts[i], sortedContact) >= 0) {
-					state.sortedContacts.splice(i, 0, sortedContact)
-					break
-				} else if (i + 1 === len) {
-					// we reached the end insert it now
+				const other = state.sortedContacts[i]
+
+				// favorite comes before non-favorite
+				const differentFavStatus = other.favorite !== sortedContact.favorite
+				const otherShouldComeFirst = differentFavStatus && other.favorite
+				const sameFavAndSortedFirst = !differentFavStatus && sortData(other, sortedContact) >= 0
+
+				if (otherShouldComeFirst || sameFavAndSortedFirst) {
+					continue
+				}
+
+				if (i + 1 === len) {
 					state.sortedContacts.push(sortedContact)
+				} else {
+					state.sortedContacts.splice(i, 0, sortedContact)
 				}
+				break
 			}


+	// alphabetical within each group
+	if (!a.value && !b.value) {
+		return 0
+	}
+	if (!a.value) {
+		return 1
+	}
+	if (!b.value) {
+		return -1
+	}
+	return a.value.localeCompare(b.value)


-			.sort(sortData)
+			.map((contact) => ({
+				key: contact.key,
+				value: (contact[state.orderKey] || '').toString().toLowerCase(),


hamza221 · 2026-05-08T10:33:07Z

+					<div
+						class="favorite-star"
+						:class="{ favorite: isFavorite }"
+						@click.stop="toggleFavorite">
+						<StarIcon
+							v-if="isFavorite"
+							:size="16"
+							class="favorite-icon" />
+					</div>


fyi @GVodyanov

DerDreschner · 2026-05-08T10:13:20Z

Works fine btw 👏🏼

Thanks for the feedback! Makes my blood pressure going down a lot 😄

hamza221 · 2026-05-08T10:21:02Z

requires #5310

ChristophWurst · 2026-05-08T11:33:40Z

requires #5310

Showtime

Signed-off-by: greta <gretadoci@gmail.com>

jancborchardt

Very nice, thank you! :)

hamza221 · 2026-05-12T13:41:12Z

/backport to stable8.5 please

GretaD self-assigned this Apr 10, 2026

GretaD added enhancement New feature or request 2. developing Work in progress labels Apr 10, 2026

This comment was marked as outdated.

Sign in to view

GretaD force-pushed the feat/sort-favorite-contacts branch from 658fb4b to 693cb61 Compare May 4, 2026 09:23

GretaD marked this pull request as ready for review May 4, 2026 09:25

GretaD requested review from GVodyanov and hamza221 as code owners May 4, 2026 09:25

GretaD added 3. to review Waiting for reviews and removed 2. developing Work in progress labels May 4, 2026

DerDreschner self-requested a review May 4, 2026 10:03

ChristophWurst reviewed May 6, 2026

View reviewed changes

Comment thread src/store/contacts.js Outdated

Comment thread src/store/contacts.js Outdated

Comment thread src/components/ContactsList/ContactsListItem.vue Outdated

Comment thread src/store/contacts.js

GVodyanov reviewed May 6, 2026

View reviewed changes

Comment thread src/components/ContactsList/ContactsListItem.vue Outdated

GVodyanov reviewed May 6, 2026

View reviewed changes

Comment thread src/components/ContactsList/ContactsListItem.vue Outdated

GVodyanov reviewed May 6, 2026

View reviewed changes

Comment thread src/components/ContactsList/ContactsListItem.vue Outdated

GVodyanov reviewed May 6, 2026

View reviewed changes

Comment thread src/components/ContactsList/ContactsListItem.vue Outdated

GVodyanov approved these changes May 6, 2026

View reviewed changes

DerDreschner requested changes May 6, 2026

View reviewed changes

GretaD requested a review from DerDreschner May 7, 2026 12:37

DerDreschner approved these changes May 7, 2026

View reviewed changes

hamza221 requested changes May 7, 2026

View reviewed changes

Comment thread src/components/ContactsList/ContactsListItem.vue Outdated

Comment thread src/components/ContactsList/ContactsListItem.vue Outdated

Comment thread src/store/contacts.js Outdated

Comment thread src/store/contacts.js Outdated

hamza221 requested changes May 7, 2026

View reviewed changes

ChristophWurst reviewed May 7, 2026

View reviewed changes

Comment thread src/store/contacts.js Outdated

Comment thread src/store/contacts.js Outdated

Comment thread src/store/contacts.js Outdated

hamza221 reviewed May 8, 2026

View reviewed changes

hamza221 requested a review from Copilot May 8, 2026 10:06

Copilot started reviewing on behalf of hamza221 May 8, 2026 10:06 View session

Copilot AI reviewed May 8, 2026

View reviewed changes

GretaD force-pushed the feat/sort-favorite-contacts branch from b4000c1 to eaca005 Compare May 8, 2026 11:47

GretaD requested a review from hamza221 May 8, 2026 12:02

GretaD force-pushed the feat/sort-favorite-contacts branch 3 times, most recently from 2ca5373 to d874b8d Compare May 8, 2026 12:18

feat: sort favorite contact first in list

bf76118

Signed-off-by: greta <gretadoci@gmail.com>

hamza221 force-pushed the feat/sort-favorite-contacts branch from d874b8d to bf76118 Compare May 8, 2026 14:21

hamza221 approved these changes May 8, 2026

View reviewed changes

GretaD merged commit 1b82f16 into main May 8, 2026
35 of 36 checks passed

GretaD deleted the feat/sort-favorite-contacts branch May 8, 2026 15:09

jancborchardt reviewed May 11, 2026

View reviewed changes

GretaD mentioned this pull request May 11, 2026

Add documentation for mark favorite as favorite nextcloud/documentation#14808

Open

4 tasks

backportbot Bot added the backport-request label May 12, 2026

backportbot Bot mentioned this pull request May 12, 2026

[stable8.5] feat: sort favorite contact first in list #5321

Merged

1 task

backportbot Bot removed the backport-request label May 12, 2026

Conversation

GretaD commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to test

Uh oh!

codecov Bot commented Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChristophWurst commented May 6, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GVodyanov left a comment

Choose a reason for hiding this comment

Uh oh!

DerDreschner left a comment

Choose a reason for hiding this comment

Uh oh!

DerDreschner left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hamza221 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChristophWurst commented May 7, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hamza221 commented May 7, 2026

Uh oh!

hamza221 May 8, 2026

Choose a reason for hiding this comment

Uh oh!

hamza221 commented May 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

hamza221 May 8, 2026

Choose a reason for hiding this comment

Uh oh!

DerDreschner commented May 8, 2026

Uh oh!

hamza221 commented May 8, 2026

Uh oh!

ChristophWurst commented May 8, 2026

Uh oh!

Uh oh!

jancborchardt left a comment

Choose a reason for hiding this comment

Uh oh!

hamza221 commented May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

GretaD commented Apr 10, 2026 •

edited

Loading

codecov Bot commented Apr 10, 2026 •

edited

Loading

hamza221 left a comment •

edited

Loading