Back to Remotion

makeHeart()

packages/docs/docs/shapes/make-heart.mdx

4.0.457959 B
Original Source

import {MakeShapeSeeAlso, ShapeOptions} from '../../components/shapes/shapes-info';

available from v4.0.315

Generates an SVG path for a heart.

Example

ts
import {makeHeart} from '@remotion/shapes';

const {path, width, height, transformOrigin, instructions} = makeHeart({
  height: 100,
});

console.log(path); // M 100 120 C 40 110 20 70 60 60 C 90 40 110 40 140 60 C 180 70 160 110 100 120 Z
console.log(width); // 200
console.log(height); // 160
console.log(transformOrigin); // "100 80"
console.log(instructions); // Instruction[]

Arguments

<ShapeOptions shape="heart" />

Return type

The function returns an object with the following properties:

  • path: The SVG path string
  • width: The width of the heart
  • height: The height of the heart
  • transformOrigin: The transform origin of the heart
  • instructions: An array of path instructions

See also

<MakeShapeSeeAlso shape="heart" />