Skip to content

🎥 Make videos programmatically with React

Update Loop docs with loop prop alternative

JonnyBurgercaabf2afe10a
diff --git a/packages/docs/docs/loop.mdx b/packages/docs/docs/loop.mdx
index c3755b19cd..f2a7c15edf 100644
--- a/packages/docs/docs/loop.mdx
+++ b/packages/docs/docs/loop.mdx
@@ -29,9 +29,24 @@ const MyComp = () => {
};
```
-:::note
-Good to know: You can nest loops within each other and they will cascade.
-:::
+You can nest loops within each other and they will cascade.
+
+## New alternative: `loop` prop
+
+[Many components](/docs/timing) accept a [`loop`](/docs/timing#loop-repeat-an-item) nowadays.
+
+It is useful if you want to mix it with other props such as `trimAfter` or `playbackRate`.
+
+```tsx twoslash
+// @include: example-BlueSquare
+import {Sequence} from 'remotion';
+// ---cut---
+const WithSequence = () => (
+ <Sequence trimAfter={50} durationInFrames={150} loop>
+ <BlueSquare />
+ </Sequence>
+);
+```
## API
@@ -63,31 +78,6 @@ CSS styles to be applied to the container. If `layout` is set to `none`, there i
`<Loop>` inherits [`premountFor`](/docs/sequence#premountfor), [`postmountFor`](/docs/sequence#postmountfor), [`styleWhilePremounted`](/docs/sequence#stylewhilepremounted) and [`styleWhilePostmounted`](/docs/sequence#stylewhilepostmounted) from [`<Sequence>`](/docs/sequence). These props require `layout="absolute-fill"` (the default). Postmounting the end of the loop requires a finite `times`.
-## Relation to `<Sequence loop>`
-
-[`<Sequence>`](/docs/sequence#loop) and other timed components accept a [`loop`](/docs/timing#loop-repeat-an-item) prop that repeats the range selected by `trimBefore` and `trimAfter`.
-
-`<Loop>` measures its period in the parent timeline and counts iterations with `times`:
-
-```tsx twoslash
-// @include: example-BlueSquare
-import {Loop, Sequence} from 'remotion';
-// ---cut---
-const WithLoop = () => (
- <Loop durationInFrames={50} times={3}>
- <BlueSquare />
- </Loop>
-);
-
-const WithSequence = () => (
- <Sequence trimAfter={50} durationInFrames={150} loop>
- <BlueSquare />
- </Sequence>
-);
-```
-
-Both render the same frames. Use `<Sequence loop>` if the content should start at a `trimBefore` offset or play at a `playbackRate`.
-
## Examples
All the examples below are based on the following animation of a blue square: