Add Safari compatibility warnings for embed component #1721
+27
−8
Conversation
This file contains hidden or 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
- Add warning to embed component page about Safari compatibility issues - Recommend using <video> component instead for embedding videos - Update markdown content page with same Safari warning - Emphasize better cross-browser support with <video> component Co-Authored-By: Colton Berry <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| - `<Download src="..." />` - read more about it [below](#downloadable-assets). | ||
|
|
||
| <Warning> | ||
| The `<embed>` component is not well-supported on Safari and may cause compatibility issues. For embedding videos, use the `<video>` component instead, which provides better cross-browser support and more control over playback. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
| <embed src="./embed-fern-waving.mp4" type="video/mp4" width="640px" height="360px" /> | ||
|
|
||
| <Warning> | ||
| The `<embed>` component is not well-supported on Safari and may cause compatibility issues. For embedding videos, use the `<video>` component instead (see below), which provides better cross-browser support and more control over playback. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
Co-Authored-By: Colton Berry <[email protected]>
- Update warnings to discourage embed for all asset types (not just videos) - Recommend video component for videos, Download component for PDFs, img tag for images - Fix broken link from /learn/docs/content/write-markdown to /learn/docs/writing-content/markdown - Add notes to PDF and video sections with recommended alternatives - Update markdown.mdx to be consistent with embed.mdx warnings Co-Authored-By: Colton Berry <[email protected]>
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.
Discourage embed component usage and fix broken links
Summary
Updated documentation to discourage using the
<embed>component for all asset types (videos, PDFs, images) due to inconsistent browser support, particularly on Safari and mobile browsers. Added warnings and recommendations to use better alternatives:<video>component for videos,<Download>component for PDFs, and<img>tag for images. Also fixed broken links that pointed to incorrect URL paths.Key changes:
<Warning>callout at top of embed component page discouraging embed usage for all asset types/learn/docs/content/write-markdown#embedding-videos→/learn/docs/writing-content/markdown#local-videos<Note>callouts recommending better alternativesReview & Testing Checklist for Human
<embed>for ALL asset types (not just videos) aligns with product direction. The original request was Safari-specific for videos, but this evolved to a blanket recommendation against embed./learn/docs/writing-content/markdown#local-videosand/learn/docs/writing-content/components/embed<video>component,<Download>component, and<img>tag work well as the recommended alternatives on various browsers.Notes