search

capacitor-community / contacts

Contacts Plugin for Capacitor
https://capacitor-community.github.io/contacts/
119 stars 52 forks source link

Add thumbnailImage projection #115

Open gregzo opened 7 months ago

gregzo commented 7 months ago

Is your feature request related to a problem? Please describe. As it stands, on iOS the plugin retrieves the full size image, which can slow things down considerably.

Describe the solution you'd like When displaying contact images as thumbnails, it would be much more efficient to retrieve CNContactThumbnailImageDataKey instead of CNContactImageDataKey.

I'm happy to give it a shot on iOS. I'd simply add a new projection for thumbnailImage and implement the Swift plugin accordingly. I have no experience with Android dev unfortunately.

Describe alternatives you've considered We could:

gregzo commented 3 months ago

After looking at the Android code, and at the relevant docs (https://developer.android.com/reference/android/provider/ContactsContract.Contacts.Photo#PHOTO), it seems that the current behaviour is to get the thumbnail size asset on Android, and the full size asset on iOS.

Ideally, we would need to parametrise the image projection to retrieve the asset matching the requested size. In order to preserve the current behaviour, I propose that we:

  1. Add an imageSize?: "display" | "thumbnail" property to Projection
  2. Map accordingly native side
  3. If imageSize is undefined, default to thumbnail size OR keep current behaviour for compatibility reasons (full size on iOS, thumbnail on Android)
tafelnl commented 3 months ago

Yeah, I have done some work on this. I've got a few changes on device locally. I'll commit them when I've got the time. If I remember correctly, I was struggling with keeping it both consistent and backwards compatible.

tafelnl commented 3 months ago

Got a work in progress branch here: https://github.com/capacitor-community/contacts/tree/feat%2Fadd-thumbnail-projection