@zync/zync-screnplay-player 0.1.211 → 0.1.213

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,9 +8,9 @@ import React, { useEffect, useState } from 'react';
8
8
  import { delayRender, continueRender, cancelRender } from 'remotion';
9
9
  import { Lottie } from '@remotion/lottie';
10
10
 
11
- /**
12
- * Convert a HEX color string (e.g. "#ff8800") to the RGBA float array that
13
- * Lottie expects: [r, g, b, a] where each component is 0‑1.
11
+ /**
12
+ * Convert a HEX color string (e.g. "#ff8800") to the RGBA float array that
13
+ * Lottie expects: [r, g, b, a] where each component is 0‑1.
14
14
  */
15
15
  var hexToRGBA = function hexToRGBA(hex) {
16
16
  var clean = hex.replace('#', '');
@@ -25,9 +25,9 @@ var hexToRGBA = function hexToRGBA(hex) {
25
25
  ];
26
26
  };
27
27
 
28
- /**
29
- * Recursively walks through shape objects and overrides any fill (fl) or
30
- * stroke (st) color with the provided RGBA array.
28
+ /**
29
+ * Recursively walks through shape objects and overrides any fill (fl) or
30
+ * stroke (st) color with the provided RGBA array.
31
31
  */
32
32
  var _applyColor = function applyColor(shapes, rgba) {
33
33
  shapes === null || shapes === void 0 ? void 0 : shapes.forEach(function (shape) {
@@ -40,11 +40,11 @@ var _applyColor = function applyColor(shapes, rgba) {
40
40
  });
41
41
  };
42
42
 
43
- /**
44
- * Traverses all layers (top‑level + asset layers) and applies the primary
45
- * color to every fill / stroke it encounters. This is useful for Lottie files
46
- * that were exported with a single static color (e.g. white) and do not use
47
- * layer naming conventions like "PrimaryColor".
43
+ /**
44
+ * Traverses all layers (top‑level + asset layers) and applies the primary
45
+ * color to every fill / stroke it encounters. This is useful for Lottie files
46
+ * that were exported with a single static color (e.g. white) and do not use
47
+ * layer naming conventions like "PrimaryColor".
48
48
  */
49
49
  var replaceGlobalColor = function replaceGlobalColor(data, hex) {
50
50
  var _data$assets;
@@ -60,16 +60,16 @@ var replaceGlobalColor = function replaceGlobalColor(data, hex) {
60
60
  });
61
61
  };
62
62
 
63
- /**
64
- * LottieAnimationGlobal – specialised wrapper to render the provided Lottie
65
- * (e.g. text‑bubble‑animation.json) while dynamically replacing **all** stroke
66
- * and fill colors with the supplied `primaryColor`.
67
- *
68
- * Props:
69
- * • animationPath – URL or local path to the json file.
70
- * • primaryColor – HEX string, defaults to "#ffffff".
71
- * • autoplay – boolean, whether to start playing immediately.
72
- * • loop – boolean, whether to loop the animation.
63
+ /**
64
+ * LottieAnimationGlobal – specialised wrapper to render the provided Lottie
65
+ * (e.g. text‑bubble‑animation.json) while dynamically replacing **all** stroke
66
+ * and fill colors with the supplied `primaryColor`.
67
+ *
68
+ * Props:
69
+ * • animationPath – URL or local path to the json file.
70
+ * • primaryColor – HEX string, defaults to "#ffffff".
71
+ * • autoplay – boolean, whether to start playing immediately.
72
+ * • loop – boolean, whether to loop the animation.
73
73
  */
74
74
  export var LottieAnimationGlobal = function LottieAnimationGlobal(_ref) {
75
75
  var animationPath = _ref.animationPath,
@@ -16,6 +16,7 @@ var Square = function Square(_ref) {
16
16
  logoUrl = _ref.logoUrl,
17
17
  logoLeft = _ref.logoLeft,
18
18
  logoTop = _ref.logoTop,
19
+ logoPosition = _ref.logoPosition,
19
20
  frameColor = _ref.frameColor,
20
21
  startVideoFrom = _ref.startVideoFrom,
21
22
  noBackgroundVideoUrl = _ref.noBackgroundVideoUrl,
@@ -164,7 +165,7 @@ var Square = function Square(_ref) {
164
165
  }
165
166
  }, children), logoUrl ? /*#__PURE__*/React.createElement("div", {
166
167
  style: {
167
- position: "fixed",
168
+ position: logoPosition || "fixed",
168
169
  left: logoLeft,
169
170
  top: logoTop,
170
171
  padding: 20,
@@ -189,6 +190,7 @@ var Portrait = function Portrait(_ref2) {
189
190
  logoUrl = _ref2.logoUrl,
190
191
  logoLeft = _ref2.logoLeft,
191
192
  logoTop = _ref2.logoTop,
193
+ logoPosition = _ref2.logoPosition,
192
194
  frameColor = _ref2.frameColor,
193
195
  startVideoFrom = _ref2.startVideoFrom,
194
196
  noBackgroundVideoUrl = _ref2.noBackgroundVideoUrl,
@@ -334,7 +336,7 @@ var Portrait = function Portrait(_ref2) {
334
336
  }
335
337
  }, children), logoUrl ? /*#__PURE__*/React.createElement("div", {
336
338
  style: {
337
- position: "fixed",
339
+ position: logoPosition || "fixed",
338
340
  left: logoLeft,
339
341
  top: logoTop,
340
342
  padding: 20,
@@ -359,6 +361,7 @@ var Landscape = function Landscape(_ref3) {
359
361
  logoUrl = _ref3.logoUrl,
360
362
  logoLeft = _ref3.logoLeft,
361
363
  logoTop = _ref3.logoTop,
364
+ logoPosition = _ref3.logoPosition,
362
365
  frameColor = _ref3.frameColor,
363
366
  startVideoFrom = _ref3.startVideoFrom,
364
367
  noBackgroundVideoUrl = _ref3.noBackgroundVideoUrl,
@@ -501,7 +504,7 @@ var Landscape = function Landscape(_ref3) {
501
504
  }
502
505
  }, children), logoUrl ? /*#__PURE__*/React.createElement("div", {
503
506
  style: {
504
- position: "fixed",
507
+ position: logoPosition || "fixed",
505
508
  left: logoLeft,
506
509
  top: logoTop,
507
510
  padding: 20,
@@ -518,6 +521,7 @@ var Landscape = function Landscape(_ref3) {
518
521
  })) : null);
519
522
  };
520
523
  var BrollStudioBackdrop = function BrollStudioBackdrop(_ref4) {
524
+ var _compositionProps$out, _window, _window$screenplayPro, _window$screenplayPro2;
521
525
  var videoUrl = _ref4.videoUrl,
522
526
  startVideoFrom = _ref4.startVideoFrom,
523
527
  brollUrl = _ref4.brollUrl,
@@ -530,11 +534,22 @@ var BrollStudioBackdrop = function BrollStudioBackdrop(_ref4) {
530
534
  noBackgroundVideoUrl = _ref4.noBackgroundVideoUrl,
531
535
  durationInFrames = _ref4.durationInFrames,
532
536
  faceMetadata = _ref4.faceMetadata,
533
- noBackgroundVideoEffects = _ref4.noBackgroundVideoEffects;
537
+ noBackgroundVideoEffects = _ref4.noBackgroundVideoEffects,
538
+ _ref4$useSquareInLand = _ref4.useSquareInLandscape,
539
+ useSquareInLandscape = _ref4$useSquareInLand === void 0 ? false : _ref4$useSquareInLand;
534
540
  var _useVideoConfig = useVideoConfig(),
535
- width = _useVideoConfig.width,
536
- height = _useVideoConfig.height,
537
- fps = _useVideoConfig.fps;
541
+ outputWidth = _useVideoConfig.width,
542
+ outputHeight = _useVideoConfig.height,
543
+ fps = _useVideoConfig.fps,
544
+ _useVideoConfig$props = _useVideoConfig.props,
545
+ compositionProps = _useVideoConfig$props === void 0 ? {} : _useVideoConfig$props;
546
+ var outputOrientation = (compositionProps === null || compositionProps === void 0 ? void 0 : (_compositionProps$out = compositionProps.output) === null || _compositionProps$out === void 0 ? void 0 : _compositionProps$out.orientation) || (typeof window !== "undefined" ? (_window = window) === null || _window === void 0 ? void 0 : (_window$screenplayPro = _window.screenplayProps) === null || _window$screenplayPro === void 0 ? void 0 : (_window$screenplayPro2 = _window$screenplayPro.output) === null || _window$screenplayPro2 === void 0 ? void 0 : _window$screenplayPro2.orientation : undefined);
547
+ var shouldUseSquareInLandscape = Boolean(useSquareInLandscape) && outputOrientation === "landscape";
548
+ var squareSize = 1080;
549
+ var width = shouldUseSquareInLandscape ? squareSize : outputWidth;
550
+ var height = shouldUseSquareInLandscape ? squareSize : outputHeight;
551
+ var renderOffsetX = shouldUseSquareInLandscape ? (outputWidth - squareSize) / 2 : 0;
552
+ var orientationOverride = shouldUseSquareInLandscape ? "square" : undefined;
538
553
  var frame = useCurrentFrame();
539
554
  var _useVirtualBackground = useVirtualBackground(),
540
555
  isVirtual = _useVirtualBackground.isVirtual,
@@ -557,7 +572,7 @@ var BrollStudioBackdrop = function BrollStudioBackdrop(_ref4) {
557
572
  logoLeft: CHROME_PADDING * 2,
558
573
  BrollStudioBackdropComponent: Square
559
574
  }
560
- }),
575
+ }, orientationOverride),
561
576
  BrollStudioBackdropComponent = _useOrientationBased.BrollStudioBackdropComponent,
562
577
  logoTop = _useOrientationBased.logoTop,
563
578
  logoLeft = _useOrientationBased.logoLeft;
@@ -595,7 +610,7 @@ var BrollStudioBackdrop = function BrollStudioBackdrop(_ref4) {
595
610
  // Middle section - fully visible
596
611
  brollSpringProgress = 1;
597
612
  }
598
- return /*#__PURE__*/React.createElement(React.Fragment, null, !disableTransitionSounds && /*#__PURE__*/React.createElement(Audio, {
613
+ var content = /*#__PURE__*/React.createElement(React.Fragment, null, !disableTransitionSounds && /*#__PURE__*/React.createElement(Audio, {
599
614
  src: "https://cdn.zync.ai/assets/static/swoosh.mp3",
600
615
  volume: 0.25
601
616
  }), /*#__PURE__*/React.createElement(BrollStudioBackdropComponent, {
@@ -610,11 +625,30 @@ var BrollStudioBackdrop = function BrollStudioBackdrop(_ref4) {
610
625
  sourceVideoOrientation: sourceVideoOrientation,
611
626
  logoLeft: logoLeft,
612
627
  logoTop: logoTop,
628
+ logoPosition: shouldUseSquareInLandscape ? "absolute" : "fixed",
613
629
  videoUrl: videoUrl,
614
630
  faceMetadata: faceMetadata,
615
631
  noBackgroundVideoEffects: noBackgroundVideoEffects,
616
632
  showVirtual: showVirtual,
617
633
  virtualBgUrl: virtualBgUrl
618
634
  }, children));
635
+ if (!shouldUseSquareInLandscape) {
636
+ return content;
637
+ }
638
+ return /*#__PURE__*/React.createElement(AbsoluteFill, {
639
+ style: {
640
+ width: outputWidth,
641
+ height: outputHeight,
642
+ backgroundColor: "black"
643
+ }
644
+ }, /*#__PURE__*/React.createElement(AbsoluteFill, {
645
+ style: {
646
+ width: width,
647
+ height: height,
648
+ left: renderOffsetX,
649
+ top: 0,
650
+ overflow: "hidden"
651
+ }
652
+ }, content));
619
653
  };
620
654
  export { BrollStudioBackdrop };
@@ -8,34 +8,34 @@ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol"
8
8
  function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
9
9
  function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
10
10
  function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
11
- /**
12
- * Face-Centered Video Component
13
- *
14
- * A reusable component that wraps OffthreadVideo to ensure the video is always
15
- * centered on a person's face within a flexible container.
16
- *
17
- * The video maintains its source dimensions and is positioned using translateX/translateY
18
- * to center the face within the container, regardless of container size.
11
+ /**
12
+ * Face-Centered Video Component
13
+ *
14
+ * A reusable component that wraps OffthreadVideo to ensure the video is always
15
+ * centered on a person's face within a flexible container.
16
+ *
17
+ * The video maintains its source dimensions and is positioned using translateX/translateY
18
+ * to center the face within the container, regardless of container size.
19
19
  */
20
20
 
21
21
  import React from "react";
22
22
  import { OffthreadVideo, useCurrentFrame } from "remotion";
23
23
  import { useOrientationBased } from "../../hooks/useOrientationBased.js";
24
24
 
25
- /**
26
- * Calculate face-centered translation for flexible container
27
- * @param {Object} params - Configuration object
28
- * @param {Object} params.faceMetadata - Face detection metadata
29
- * @param {number} params.containerWidth - Container width in pixels
30
- * @param {number} params.containerHeight - Container height in pixels
31
- * @param {number} params.currentFrame - Current frame number (optional)
32
- * @param {boolean} params.enableInterpolation - Whether to interpolate between frames
33
- * @param {boolean} params.useAveragePosition - Whether to use average face position
34
- * @param {boolean} params.centerHorizontally - Whether to only center horizontally
35
- * @param {number} params.translateX - Additional translateX offset
36
- * @param {number} params.translateY - Additional translateY offset
37
- * @param {string} params.orientation - Viewport orientation (portrait, square, landscape)
38
- * @returns {Object} Transform styles and debug info
25
+ /**
26
+ * Calculate face-centered translation for flexible container
27
+ * @param {Object} params - Configuration object
28
+ * @param {Object} params.faceMetadata - Face detection metadata
29
+ * @param {number} params.containerWidth - Container width in pixels
30
+ * @param {number} params.containerHeight - Container height in pixels
31
+ * @param {number} params.currentFrame - Current frame number (optional)
32
+ * @param {boolean} params.enableInterpolation - Whether to interpolate between frames
33
+ * @param {boolean} params.useAveragePosition - Whether to use average face position
34
+ * @param {boolean} params.centerHorizontally - Whether to only center horizontally
35
+ * @param {number} params.translateX - Additional translateX offset
36
+ * @param {number} params.translateY - Additional translateY offset
37
+ * @param {string} params.orientation - Viewport orientation (portrait, square, landscape)
38
+ * @returns {Object} Transform styles and debug info
39
39
  */
40
40
  var calculateFaceCenteredTranslation = function calculateFaceCenteredTranslation(_ref) {
41
41
  var _faceMetadata$metadat, _faceMetadata$metadat2;
@@ -214,8 +214,8 @@ var calculateFaceCenteredTranslation = function calculateFaceCenteredTranslation
214
214
  };
215
215
  };
216
216
 
217
- /**
218
- * Get face data for a specific frame with optional interpolation
217
+ /**
218
+ * Get face data for a specific frame with optional interpolation
219
219
  */
220
220
  function getFaceDataForFrame(frames, frameIndex, enableInterpolation) {
221
221
  var _prevFrame, _nextFrame;
@@ -274,8 +274,8 @@ function getFaceDataForFrame(frames, frameIndex, enableInterpolation) {
274
274
  return ((_prevFrame = prevFrame) === null || _prevFrame === void 0 ? void 0 : _prevFrame.data) || ((_nextFrame = nextFrame) === null || _nextFrame === void 0 ? void 0 : _nextFrame.data) || null;
275
275
  }
276
276
 
277
- /**
278
- * Calculate average face position from all frames with face data
277
+ /**
278
+ * Calculate average face position from all frames with face data
279
279
  */
280
280
  function getAverageFaceData(frames) {
281
281
  if (!frames || frames.length === 0) return null;
@@ -310,14 +310,14 @@ function getAverageFaceData(frames) {
310
310
  };
311
311
  }
312
312
 
313
- /**
314
- * Calculate the negative space offset when face-centering a video
315
- *
316
- * @param {Object} faceMetadata - Face detection metadata object
317
- * @param {number} containerWidth - Container width in pixels
318
- * @param {number} containerHeight - Container height in pixels
319
- * @param {number} scale - Scale factor applied to the video
320
- * @returns {Object} Object containing horizontal and vertical offsets and which side has negative space
313
+ /**
314
+ * Calculate the negative space offset when face-centering a video
315
+ *
316
+ * @param {Object} faceMetadata - Face detection metadata object
317
+ * @param {number} containerWidth - Container width in pixels
318
+ * @param {number} containerHeight - Container height in pixels
319
+ * @param {number} scale - Scale factor applied to the video
320
+ * @returns {Object} Object containing horizontal and vertical offsets and which side has negative space
321
321
  */
322
322
  export var calculateNegativeSpaceOffset = function calculateNegativeSpaceOffset(faceMetadata, containerWidth, containerHeight) {
323
323
  var _faceMetadata$metadat4, _faceMetadata$metadat5;
@@ -415,22 +415,22 @@ export var calculateNegativeSpaceOffset = function calculateNegativeSpaceOffset(
415
415
  };
416
416
  };
417
417
 
418
- /**
419
- * FaceCenteredVideo Component
420
- * @param {Object} props - Component props
421
- * @param {string} props.src - Video source URL
422
- * @param {Object} props.faceMetadata - Face detection metadata
423
- * @param {number} props.containerWidth - Container width in pixels (required)
424
- * @param {number} props.containerHeight - Container height in pixels (required)
425
- * @param {boolean} props.enableInterpolation - Whether to interpolate between frames
426
- * @param {boolean} props.useAveragePosition - Whether to use average face position for entire video duration
427
- * @param {boolean} props.centerHorizontally - Whether to only center horizontally (X axis), not vertically (Y axis)
428
- * @param {number} props.translateX - Additional translateX offset (optional)
429
- * @param {number} props.translateY - Additional translateY offset (optional)
430
- * @param {boolean} props.showDebugInfo - Whether to show debug information
431
- * @param {Object} props.style - Additional styles to apply to video
432
- * @param {string} props.className - CSS class name
433
- * @param {...Object} props.otherProps - Other props to pass to OffthreadVideo
418
+ /**
419
+ * FaceCenteredVideo Component
420
+ * @param {Object} props - Component props
421
+ * @param {string} props.src - Video source URL
422
+ * @param {Object} props.faceMetadata - Face detection metadata
423
+ * @param {number} props.containerWidth - Container width in pixels (required)
424
+ * @param {number} props.containerHeight - Container height in pixels (required)
425
+ * @param {boolean} props.enableInterpolation - Whether to interpolate between frames
426
+ * @param {boolean} props.useAveragePosition - Whether to use average face position for entire video duration
427
+ * @param {boolean} props.centerHorizontally - Whether to only center horizontally (X axis), not vertically (Y axis)
428
+ * @param {number} props.translateX - Additional translateX offset (optional)
429
+ * @param {number} props.translateY - Additional translateY offset (optional)
430
+ * @param {boolean} props.showDebugInfo - Whether to show debug information
431
+ * @param {Object} props.style - Additional styles to apply to video
432
+ * @param {string} props.className - CSS class name
433
+ * @param {...Object} props.otherProps - Other props to pass to OffthreadVideo
434
434
  */
435
435
  export var FaceCenteredVideo = function FaceCenteredVideo(_ref2) {
436
436
  var _faceMetadata$metadat7, _faceMetadata$metadat8, _faceMetadata$metadat9, _faceMetadata$metadat10;
@@ -15,10 +15,10 @@ function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t =
15
15
  import React, { useEffect, useState } from "react";
16
16
  import { Img, delayRender, continueRender } from "remotion";
17
17
 
18
- /**
19
- * PausableImg component that extends Remotion's Img with fetch validation.
20
- * It delays rendering until the image source can be successfully fetched.
21
- * If there's an error fetching the image, it renders nothing.
18
+ /**
19
+ * PausableImg component that extends Remotion's Img with fetch validation.
20
+ * It delays rendering until the image source can be successfully fetched.
21
+ * If there's an error fetching the image, it renders nothing.
22
22
  */
23
23
  export var PausableImg = /*#__PURE__*/React.memo(function (_ref) {
24
24
  var src = _ref.src,
@@ -1,80 +1,80 @@
1
- # StretchText Component
2
-
3
- A React component that renders text that stretches to fit the parent's width. Words with fewer characters will have a larger font size than words with more characters. The component uses SVG for rendering text, which ensures proper text-stroke rendering in headless mode.
4
-
5
- ## Usage
6
-
7
- ```jsx
8
- import StretchText from './StretchText';
9
-
10
- // Basic usage
11
- <StretchText text="Hello World" />
12
-
13
- // With custom styling
14
- <StretchText
15
- text="Contribution"
16
- color="#1a73e8"
17
- fontFamily="Arial"
18
- maxFontSize={200}
19
- minFontSize={10}
20
- style={{ fontWeight: 'bold' }}
21
- />
22
-
23
- // With text stroke
24
- <StretchText
25
- text="Outlined Text"
26
- color="transparent"
27
- textStrokeColor="white"
28
- textStrokeWidth="2px"
29
- style={{ fontWeight: 'bold' }}
30
- />
31
- ```
32
-
33
- ## Props
34
-
35
- | Prop | Type | Default | Description |
36
- |------|------|---------|-------------|
37
- | `text` | string | required | The text to display |
38
- | `color` | string | '#000000' | Text color |
39
- | `fontFamily` | string | 'Arial' | Font family |
40
- | `maxFontSize` | number | 100 | Maximum font size in pixels |
41
- | `minFontSize` | number | 10 | Minimum font size in pixels |
42
- | `textStrokeColor` | string | undefined | Color of the text stroke |
43
- | `textStrokeWidth` | string | undefined | Width of the text stroke (e.g., '2px') |
44
- | `textFillColor` | string | undefined | Color of the text fill (overrides `color` if provided) |
45
- | `style` | object | {} | Additional style properties |
46
-
47
- ## Examples
48
-
49
- The component automatically calculates the appropriate font size to make the text stretch to fit the parent width. For example:
50
-
51
- - "Work" (4 characters) will have a larger font size than "Contribution" (12 characters) when both are rendered in containers of the same width.
52
- - The text will always be contained within the parent container and will not overflow.
53
- - The component recalculates the font size when the window is resized.
54
-
55
- ## Demo
56
-
57
- You can see a demo of the StretchText component by running the development environment and looking at the first segment in the video timeline.
58
-
59
- The demo shows several words of different lengths rendered in containers of the same width:
60
-
61
- - "Contribution" (longer word, smaller font)
62
- - "Work" (shorter word, larger font)
63
- - "Hello" (medium length word, medium font)
64
- - "Supercalifragilisticexpialidocious" (very long word, very small font)
65
-
66
- Each word stretches to fill the entire width of its container, demonstrating how the component automatically adjusts the font size based on the text length.
67
-
68
- ## Implementation Details
69
-
70
- The component uses a binary search algorithm to find the optimal font size that makes the text fit the parent width. It uses a simple approximation for text width calculation (character count * fontSize * 0.75) which works well for most fonts.
71
-
72
- The component uses SVG for rendering text, which provides several advantages:
73
- - Proper text-stroke rendering in headless mode
74
- - Better control over text positioning and alignment
75
- - Consistent rendering across different browsers and environments
76
- - Support for advanced SVG features like filters for text shadows
77
-
78
- For text with stroke effects, the component uses SVG's native stroke and fill attributes, which are more reliable than CSS text-stroke properties, especially in headless rendering environments.
79
-
80
- The component also includes a resize listener to recalculate the font size when the window size changes.
1
+ # StretchText Component
2
+
3
+ A React component that renders text that stretches to fit the parent's width. Words with fewer characters will have a larger font size than words with more characters. The component uses SVG for rendering text, which ensures proper text-stroke rendering in headless mode.
4
+
5
+ ## Usage
6
+
7
+ ```jsx
8
+ import StretchText from './StretchText';
9
+
10
+ // Basic usage
11
+ <StretchText text="Hello World" />
12
+
13
+ // With custom styling
14
+ <StretchText
15
+ text="Contribution"
16
+ color="#1a73e8"
17
+ fontFamily="Arial"
18
+ maxFontSize={200}
19
+ minFontSize={10}
20
+ style={{ fontWeight: 'bold' }}
21
+ />
22
+
23
+ // With text stroke
24
+ <StretchText
25
+ text="Outlined Text"
26
+ color="transparent"
27
+ textStrokeColor="white"
28
+ textStrokeWidth="2px"
29
+ style={{ fontWeight: 'bold' }}
30
+ />
31
+ ```
32
+
33
+ ## Props
34
+
35
+ | Prop | Type | Default | Description |
36
+ |------|------|---------|-------------|
37
+ | `text` | string | required | The text to display |
38
+ | `color` | string | '#000000' | Text color |
39
+ | `fontFamily` | string | 'Arial' | Font family |
40
+ | `maxFontSize` | number | 100 | Maximum font size in pixels |
41
+ | `minFontSize` | number | 10 | Minimum font size in pixels |
42
+ | `textStrokeColor` | string | undefined | Color of the text stroke |
43
+ | `textStrokeWidth` | string | undefined | Width of the text stroke (e.g., '2px') |
44
+ | `textFillColor` | string | undefined | Color of the text fill (overrides `color` if provided) |
45
+ | `style` | object | {} | Additional style properties |
46
+
47
+ ## Examples
48
+
49
+ The component automatically calculates the appropriate font size to make the text stretch to fit the parent width. For example:
50
+
51
+ - "Work" (4 characters) will have a larger font size than "Contribution" (12 characters) when both are rendered in containers of the same width.
52
+ - The text will always be contained within the parent container and will not overflow.
53
+ - The component recalculates the font size when the window is resized.
54
+
55
+ ## Demo
56
+
57
+ You can see a demo of the StretchText component by running the development environment and looking at the first segment in the video timeline.
58
+
59
+ The demo shows several words of different lengths rendered in containers of the same width:
60
+
61
+ - "Contribution" (longer word, smaller font)
62
+ - "Work" (shorter word, larger font)
63
+ - "Hello" (medium length word, medium font)
64
+ - "Supercalifragilisticexpialidocious" (very long word, very small font)
65
+
66
+ Each word stretches to fill the entire width of its container, demonstrating how the component automatically adjusts the font size based on the text length.
67
+
68
+ ## Implementation Details
69
+
70
+ The component uses a binary search algorithm to find the optimal font size that makes the text fit the parent width. It uses a simple approximation for text width calculation (character count * fontSize * 0.75) which works well for most fonts.
71
+
72
+ The component uses SVG for rendering text, which provides several advantages:
73
+ - Proper text-stroke rendering in headless mode
74
+ - Better control over text positioning and alignment
75
+ - Consistent rendering across different browsers and environments
76
+ - Support for advanced SVG features like filters for text shadows
77
+
78
+ For text with stroke effects, the component uses SVG's native stroke and fill attributes, which are more reliable than CSS text-stroke properties, especially in headless rendering environments.
79
+
80
+ The component also includes a resize listener to recalculate the font size when the window size changes.
@@ -2,9 +2,9 @@ import React from "react";
2
2
  import { AbsoluteFill } from "remotion";
3
3
  import StretchText from "./StretchText";
4
4
 
5
- /**
6
- * Demo component to showcase the StretchText component
7
- * Shows how different words stretch to the same width with different font sizes
5
+ /**
6
+ * Demo component to showcase the StretchText component
7
+ * Shows how different words stretch to the same width with different font sizes
8
8
  */
9
9
  var StretchTextDemo = function StretchTextDemo() {
10
10
  var containerStyle = {
@@ -1,11 +1,11 @@
1
- /**
2
- * Converts seconds and a portion of frames to a numeric value of seconds.
3
- *
4
- * @param {number} seconds - The number of full seconds.
5
- * @param {number} nthFrame - The current frame within the second.
6
- * @param {number} delayInSeconds - Optional delay that adds up to the calculation
7
- * @param {number} frameRate - The frame rate (frames per second).
8
- * @return {number} The total time in seconds (with decimals for frames).
1
+ /**
2
+ * Converts seconds and a portion of frames to a numeric value of seconds.
3
+ *
4
+ * @param {number} seconds - The number of full seconds.
5
+ * @param {number} nthFrame - The current frame within the second.
6
+ * @param {number} delayInSeconds - Optional delay that adds up to the calculation
7
+ * @param {number} frameRate - The frame rate (frames per second).
8
+ * @return {number} The total time in seconds (with decimals for frames).
9
9
  */
10
10
  export var convertToSeconds = function convertToSeconds(seconds, nthFrame) {
11
11
  var delayInSeconds = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 0;
@@ -4,10 +4,10 @@ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r)
4
4
  function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
5
5
  function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
6
6
  function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
7
- /**
8
- * Calculate video styles based on face detection metadata
9
- * This helper adjusts video positioning and transform origin to center faces in the viewport
10
- * when zooming, accounting for objectFit: "cover" behavior
7
+ /**
8
+ * Calculate video styles based on face detection metadata
9
+ * This helper adjusts video positioning and transform origin to center faces in the viewport
10
+ * when zooming, accounting for objectFit: "cover" behavior
11
11
  */
12
12
  export var getFaceBasedVideoStyles = function getFaceBasedVideoStyles(_ref) {
13
13
  var faceMetadata = _ref.faceMetadata,