Interfaces

PathProps

Paint attributes shared by every drawing component, <Group>, and <Paint>.

Extends

Properties

antiAlias?

optional antiAlias?: boolean;

Inherited from

PaintProps.antiAlias


blendMode?

optional blendMode?: BlendMode;

How this drawing composites onto what is already there. 'srcOver' by default.

Inherited from

PaintProps.blendMode


children?

optional children?: ReactNode;

Inherited from

PaintProps.children


color?

optional color?: Animated<Color>;

Inherited from

PaintProps.color


end?

optional end?: Animated<number>;

Where to stop, 0-1. end below start draws the segment reversed.


fillType?

optional fillType?: "winding" | "evenOdd";

How the path decides what is inside. 'winding' by default.


opacity?

optional opacity?: Animated<number>;

Paint-wide alpha multiplier in [0, 1]; only one per chain can animate.

Inherited from

PaintProps.opacity


path

path: Animated<string>;

SVG path data. A SharedValue (or a handle.set({ path }) write) gets a string slot: the engine re-parses on the render thread when the value changes, with no scene re-encode.


ref?

optional ref?: NodeHandle;

A handle from useNode(), for changing this node without a React render. See NodeHandle.

Inherited from

PaintProps.ref


start?

optional start?: Animated<number>;

Where along the path to start drawing, 0-1. Animatable - this is line-drawing.


strokeCap?

optional strokeCap?: "butt" | "round" | "square";

Inherited from

PaintProps.strokeCap


strokeJoin?

optional strokeJoin?: "round" | "miter" | "bevel";

Inherited from

PaintProps.strokeJoin


strokeMiter?

optional strokeMiter?: Animated<number>;

Past this length-over-width ratio a 'miter' join falls back to bevel. Defaults to 4.

Inherited from

PaintProps.strokeMiter


strokeWidth?

optional strokeWidth?: Animated<number>;

Inherited from

PaintProps.strokeWidth


style?

optional style?: "fill" | "stroke";

'fill' (default) or 'stroke'.

Inherited from

PaintProps.style


visible?

optional visible?: Animated<number | boolean>;

Skip drawing (and hit-testing) this node. A value slot, so a handle or a SharedValue toggles it with no re-encode - the supported way to pool mounted nodes for particle systems and variable-count scenes.

Inherited from

PaintProps.visible