feat: add tweet element #228
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathonherbert
approved these changes
Mar 30, 2022
|
🎉 This PR is included in version 4.5.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
Old tweet element:
New tweet element (as rendered in ProseMirror):
Notes
This element is one of two ways of embedding tweets. If you choose to embed a tweet element using Twitter's embed code, you will get a generic Embed element, which has a rich preview. If you choose to embed a tweet element using a Twitter url, you will get a Tweet element powered by Embedly, which has a very basic preview (as above). Even though the preview looks worse, we recommend users use the Tweet element over the generic Embed element, as Embedly is more likely to support any third-party changes.
We are dropping the caption field. This is because in a sample of a few hundred tweet elements, we did not see any caption fields present. It was likely never important - the field was not being persisted in the flexible model for the Tweet element fields, though it may have been surfacing in the generic Element fields. We are keeping the caption field in the data model, so that it is backwards compatible with any elements that may have had this field, but we are silently dropping the ability to create new captions.
How to test
See if you can create a tweet element in the demo file. Run the new fixture test for the tweet element.
How can we measure success?
The element replicates the previous element as closely as possible (with noted upgrades).