Docs: Update Elements submission guidelines#8628
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Reviewed changes — Reworked Elements submission guidelines, template, and examples to position Elements as <Sequence>-wrapped building blocks rather than full <Composition>-based demos. The <ElementPage> component now has defaults for preview dimensions, so Element authors only need to export a single React component.
ElementPageprops become optional with defaults —width,height,fps, anddurationInFramesnow default to 1920×1080 at 30fps for 120 frames, removing the need for Element authors to export these constants.- Template switches from
<Composition>to<Sequence>— theelements-templatenow wraps content in<Sequence width={1080} height={1080}>and drops theRemotionRootcomposition wrapper and all exported dimension constants. - Lower-third example updated to match — uses
<Sequence width={900} height={260}>, readsdurationInFramesfromuseVideoConfig()for the exit animation (adapts to the host composition's duration), and adds a subtitle line with an animated accent bar. - Submission guidelines rewritten — emphasizes the building-block model, interactivity (
<Interactive.Div>), and the hosted-page-provided preview dimensions. Removes the oldRemotionRoot/ exported-constants requirement. - Tests flipped to negative assertions — elements tests now assert that source files do NOT export
durationInFrames,fps,width,height, orRemotionRoot, and do NOT contain<Composition.
✅ No new issues found.
All 9 elements tests pass. The Interactive symbol and Interactive.Div are verified to be valid exports from remotion. The lower-third exit animation correctly adapts to the host composition's duration via useVideoConfig().durationInFrames.
DeepSeek Pro (free via Pullfrog for OSS) | 𝕏
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
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.

Summary
Validation
cd packages/docs && bunx oxfmt src --writebun test packages/docs/src/test/elements.test.tsbun run buildbun run stylecheck(fails in existingtemplate-react-router#lintgenerated types:Generic type 'GetAnnotations' requires 1 type argument(s))