docs update : embed and super hero video controls#59
Open
BaskarMitrah wants to merge 1 commit into
Open
Conversation
Contributor
🔍 Linter ReportClick to expand full reportThis comment was automatically generated by the linter bot. |
melissag-ensemble
requested changes
May 25, 2026
| ``` | ||
|
|
||
| ```markdown | ||
| <Embed slots="video" controls="false" /> |
| - When present, playback starts automatically when the player loads. Browser autoplay policies (muted requirement, user gesture, etc.) may still apply. | ||
|
|
||
| - **controls** (optional) | ||
| - Set to `"false"` to hide the default player controls. Example: `<Embed slots="video" controls="false" />`. |
Contributor
There was a problem hiding this comment.
- mention that hiding controls forces autoplay
- move example under Examples
| - When present, the video repeats when it finishes. Example: `<Embed slots="video" loop />` or `<Embed slots="video" loop/>`. | ||
|
|
||
| - **autoplay** (optional, boolean) | ||
| - When present, playback starts automatically when the player loads. Browser autoplay policies (muted requirement, user gesture, etc.) may still apply. |
Contributor
There was a problem hiding this comment.
For YouTube (shorts, isShort, normal), Vimeo, and MP4, the block adds muting automatically when autoplay is on. But Instagram, TikTok, and Twitter pass autoplay through without muting — those are third-party iframes the block doesn't control. The "muted requirement" in parentheses implies muting is always the author's problem; it should be removed or clarified to distinguish platforms where muting is handled vs. where it isn't.
|
|
||
| - **Video playback** (optional, when `video` is in `slots`): Add any of these as boolean attributes on the opening `<Superhero>` tag (no value) | ||
| - **controls** — Present to show the default browser video controls. | ||
| - **autoplay** — Start playback when the hero loads. |
Contributor
There was a problem hiding this comment.
On by default; off when controls is set. Adding autoplay re-enables it and mute.
| - **overGradient**: Improves button visibility over a gradient background | ||
|
|
||
| - **Video playback** (optional, when `video` is in `slots`): Add any of these as boolean attributes on the opening `<Superhero>` tag (no value) | ||
| - **controls** — Present to show the default browser video controls. |
Contributor
| - **Video playback** (optional, when `video` is in `slots`): Add any of these as boolean attributes on the opening `<Superhero>` tag (no value) | ||
| - **controls** — Present to show the default browser video controls. | ||
| - **autoplay** — Start playback when the hero loads. | ||
| - **loop** — Repeat the video when it ends. |
| - **loop** — Repeat the video when it ends. | ||
|
|
||
| <Superhero slots="image, heading, text, buttons" variant="halfWidth" /> | ||
| **Example :** |
Contributor
There was a problem hiding this comment.
Suggested change
| **Example :** | |
| **Example:** |
| * [View Examples](https://example.com/examples) | ||
| ``` | ||
|
|
||
| <Superhero slots="fullWidthBackground, video, heading, text, buttons" variant="halfWidth" textColor="white" overGradient /> |
Contributor
There was a problem hiding this comment.
this rendered example needs to match the syntax
Suggested change
| <Superhero slots="fullWidthBackground, video, heading, text, buttons" variant="halfWidth" textColor="white" overGradient controls autoplay loop /> |
| - **autoplay** (optional, boolean) | ||
| - When present, playback starts automatically when the player loads. Browser autoplay policies (muted requirement, user gesture, etc.) may still apply. | ||
|
|
||
| - **controls** (optional) |
Contributor
There was a problem hiding this comment.
Suggested change
| - **controls** (optional) | |
| - **nocontrols** (optional, boolean) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Update the documentation for the Embed and Super Hero video controls.