-
Notifications
You must be signed in to change notification settings - Fork 379
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MSC2765: Widget avatars #2765
MSC2765: Widget avatars #2765
Conversation
@@ -0,0 +1,51 @@ | |||
# MSC2765: Widget avatars |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Widgets aren't in the spec at all yet, a ctrl+f on the unstable c-s api for "widget" or "m.custom" yields nothing. If you are building on an existing MSC, please link it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's specifically not linked due to pending spec pr: #2764
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah great, thank you
Implementation: matrix-org/matrix-react-sdk@31cca5e#diff-03cda8b2a954cc8d1ae4a08eb8576328R115-R117 (it's real tiny) |
no one has vehemently opposed this so send this into its next stage of life: @mscbot fcp merge |
Team member @turt2live has proposed to merge this. The next step is review by the rest of the tagged people: Once at least 75% of reviewers approve (and there are no outstanding concerns), this will enter its final comment period. If you spot a major issue that hasn't been raised at any point in this process, please speak up! See this document for information about what commands tagged team members can give me. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to care about speccing behaviour where somebody sets the avatar url to []
or a number? I imagine we just need to warn clients to be careful?
That sounds like it's implicitly covered as invalid data. |
"type": "m.custom", | ||
"url": "https://example.org/my/widget.html?roomId=$matrix_room_id", | ||
"waitForIframeLoad": true, | ||
"avatar_url": "mxc://example.org/abc123" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait, why is this using underscores when the other properties are using camel case?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Historical consistency: when the widget API was introduced years ago it was done as a mix, and this is in line with the perceived standard set forth.
Thought it was located somewhere else. Ideally we'd fix this over time to be all underscored
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fair enough I guess.
Co-authored-by: Hubert Chathi <hubert@uhoreg.ca>
## Alternatives | ||
|
||
We could define a whole structured system for different thumbnail sizes, though we have a thumbnail | ||
API which can be used to request whatever size is needed by the client. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One consideration is that you can significantly improve the quality of icons by having specific bitmaps for each size, so that extra detail can be included in larger icons but smaller ones can be simple. We don't necessarily need to do this now but since you've said above that avatar_url
should look good at 20x20, it implies this avatar is intended to be displayed fairly small, so we could introduce other fields for more detailed icons in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yea, this is definitely something for a future MSC. I'd like to solve the general case of client-supplied thumbnails at the same time, possibly for user/room avatars too. Something like "when you display my avatar as 500x500, use this one". Abuse/lying about different avatars would be an interesting problem to solve though.
🔔 This is now entering its final comment period, as per the review above. 🔔 |
The final comment period, with a disposition to merge, as per the review above, is now complete. |
Rendered