@remotion/layout-utils 4.0.243 → 4.0.245

package/LICENSE.md

@@ -11,7 +11,7 @@ Depending on the type of your legal entity, you are granted permission to use Re
 
 ## Free license
 
-Copyright © 2024 [Remotion](https://www.remotion.dev)
+Copyright © 2025 [Remotion](https://www.remotion.dev)
 
 ### Eligibility
 

package/dist/cjs/layouts/fit-text.d.ts

@@ -1,19 +1,4 @@
 import type { ModifyableCSSProperties, TextTransform } from '../layouts/measure-text';
-/**
- * @description Calculates the font size needed to fit text into a specified width container.
- * @see [Documentation](https://remotion.dev/docs/layout-utils/fit-text)
- * @param {Object} params - The parameters containing details to fit text.
- * @param {string} params.text - The text content to fit.
- * @param {number} params.withinWidth - The container width to fit the text into.
- * @param {string} params.fontFamily - The font family to apply to the text.
- * @param {string|number} [params.fontWeight] - The font weight to apply (optional).
- * @param {string} [params.letterSpacing] - The spacing between letters (optional).
- * @param {string} [params.fontVariantNumeric] - The numeric font variant to apply (optional).
- * @param {boolean} [params.validateFontIsLoaded] - Validate if the font is loaded before rendering text (optional).
- * @param {TextTransform} [params.textTransform] - Text transformation to apply (uppercase, lowercase) (optional).
- * @param {ModifyableCSSProperties} [params.additionalStyles] - Additional CSS properties affecting text layout (optional).
- * @returns {Object} An object containing the computed `fontSize` to use for the specified width.
- */
 export declare const fitText: ({ text, withinWidth, fontFamily, fontVariantNumeric, fontWeight, letterSpacing, validateFontIsLoaded, additionalStyles, textTransform, }: {
     text: string;
     withinWidth: number;

package/dist/cjs/layouts/fit-text.js

@@ -3,20 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fitText = void 0;
 const measure_text_1 = require("../layouts/measure-text");
 const sampleSize = 100;
-/**
+/*
  * @description Calculates the font size needed to fit text into a specified width container.
  * @see [Documentation](https://remotion.dev/docs/layout-utils/fit-text)
- * @param {Object} params - The parameters containing details to fit text.
- * @param {string} params.text - The text content to fit.
- * @param {number} params.withinWidth - The container width to fit the text into.
- * @param {string} params.fontFamily - The font family to apply to the text.
- * @param {string|number} [params.fontWeight] - The font weight to apply (optional).
- * @param {string} [params.letterSpacing] - The spacing between letters (optional).
- * @param {string} [params.fontVariantNumeric] - The numeric font variant to apply (optional).
- * @param {boolean} [params.validateFontIsLoaded] - Validate if the font is loaded before rendering text (optional).
- * @param {TextTransform} [params.textTransform] - Text transformation to apply (uppercase, lowercase) (optional).
- * @param {ModifyableCSSProperties} [params.additionalStyles] - Additional CSS properties affecting text layout (optional).
- * @returns {Object} An object containing the computed `fontSize` to use for the specified width.
  */
 const fitText = ({ text, withinWidth, fontFamily, fontVariantNumeric, fontWeight, letterSpacing, validateFontIsLoaded, additionalStyles, textTransform, }) => {
     const estimate = (0, measure_text_1.measureText)({

package/dist/cjs/layouts/measure-text.d.ts

@@ -19,12 +19,5 @@ export type Word = {
     validateFontIsLoaded?: boolean;
     additionalStyles?: ModifyableCSSProperties;
 } & CSSPropertiesOnWord;
-/**
- * Calculates the width and height of specified text to be used for layout calculations.
- * Only works in the browser, not in Node.js or Bun.
- * @see [Documentation](https://remotion.dev/docs/layout-utils/measure-text)
- * @param {Word} wordOptions - The text options to measure, including the text itself, font properties, and additional styles.
- * @returns {Dimensions} The dimensions object containing the measured width and height of the text.
- */
 export declare const measureText: ({ text, fontFamily, fontSize, fontWeight, letterSpacing, fontVariantNumeric, validateFontIsLoaded, additionalStyles, }: Word) => Dimensions;
 export {};

package/dist/cjs/layouts/measure-text.js

@@ -43,12 +43,9 @@ const takeMeasurement = ({ text, fontFamily, fontSize, fontWeight, letterSpacing
         computedFontFamily,
     };
 };
-/**
- * Calculates the width and height of specified text to be used for layout calculations.
- * Only works in the browser, not in Node.js or Bun.
+/*
+ * @description Calculates the width and height of specified text to be used for layout calculations. Only works in the browser, not in Node.js or Bun.
  * @see [Documentation](https://remotion.dev/docs/layout-utils/measure-text)
- * @param {Word} wordOptions - The text options to measure, including the text itself, font properties, and additional styles.
- * @returns {Dimensions} The dimensions object containing the measured width and height of the text.
  */
 const measureText = ({ text, fontFamily, fontSize, fontWeight, letterSpacing, fontVariantNumeric, validateFontIsLoaded, additionalStyles, }) => {
     const key = `${text}-${fontFamily}-${fontWeight}-${fontSize}-${letterSpacing}-${JSON.stringify(additionalStyles)}`;

package/package.json

@@ -3,7 +3,7 @@
     "url": "https://github.com/remotion-dev/remotion/tree/main/packages/layout-utils"
   },
   "name": "@remotion/layout-utils",
-  "version": "4.0.243",
+  "version": "4.0.245",
   "description": "Utilities for working with layouts",
   "main": "dist/cjs/index.js",
   "types": "dist/cjs/index.d.ts",
@@ -20,7 +20,7 @@
   },
   "devDependencies": {
     "eslint": "9.14.0",
-    "@remotion/eslint-config-internal": "4.0.243"
+    "@remotion/eslint-config-internal": "4.0.245"
   },
   "author": "Yehor Misiats (https://github.com/satelllte)",
   "maintainers": [