Skip to main content

<Callout />

Part of the @remotion/shapes package.

Renders an SVG element containing a callout shape.

Explorer​

Drag current shape into a layer in the Studio

Example​

src/Callout.tsx
import { Callout } from "@remotion/shapes";
import { AbsoluteFill } from "remotion";

export const MyComposition = () => {
  return (
    <AbsoluteFill
      style={{
        backgroundColor: "white",
        justifyContent: "center",
        alignItems: "center",
      }}
    >
      <Callout
        width={500}
        height={200}
        pointerLength={40}
        pointerBaseWidth={60}
        pointerDirection="down"
        cornerRadius={20}
        fill="#20232a"
      />
    </AbsoluteFill>
  );
};

Props​

width

number

The width of the callout body. Default 500.

height

number

The height of the callout body. Default 200.

pointerLength

number

The length of the pointer. Default 40.

pointerBaseWidth

number

The width of the pointer where it meets the body. Default 60.

pointerPosition

number

The position of the pointer along its side, from 0 to 1. Default 0.5.

pointerDirection

"left" | "right" | "up" | "down"

The direction the pointer points. Default down.

edgeRoundness

number | null

Allows to modify the shape by rounding the edges using bezier curves. Default null.

fill

string

The color of the shape.

stroke

string

The color of the stroke. Should be used together with strokeWidth.

strokeWidth

string

The width of the stroke. Should be used together with stroke.

style

string

CSS properties that will be applied to the <svg> tag, or to the generated <canvas> if effects are passed. Default style: overflow: 'visible'

pathStyle

string

CSS properties that will be applied to the <path> tag. Default style: transform-box: 'fill-box' and a dynamically calculated transform-origin which is the center of the shape, so that the shape rotates around its center by default.

strokeDasharray

string

Allows to animate a path. See evolvePath() for an example.

strokeDashoffset

string

Allows to animate a path. See evolvePath() for an example.

effects

EffectsProp

Apply effects after the shape has been painted to a canvas. Available from v4.0.474. If this is a non-empty array, the shape is wrapped in <HtmlInCanvas>.

pixelDensity

number

Controls the backing bitmap density when effects are passed. Default: 1. Available from v4.0.474.

cornerRadius

number

Rounds the corner using an arc. Similar to CSS's border-radius. Cannot be used together with edgeRoundness.

debug

boolean

If enabled, draws the lines for Bézier curves. This is meant for debugging, note that the visuals may change in any version.

Inherited propsv4.0.474

<Callout> inherits from, durationInFrames, name, showInTimeline and hidden from <Sequence>.

Other props

All other props that can be passed to a <path> are accepted and will be forwarded.

See also​