RiveProps
interface RiveProps extends RectProps
Properties
alignContent
Inherited from RectProps.alignContentalignItems
Inherited from RectProps.alignItemsalignSelf
Inherited from RectProps.alignSelfanimationId
animationId?: SignalValuestringnumber
antialiased
antialiased?: SignalValueboolean
RectProps.antialiasedarrowSize
arrowSize?: SignalValuenumber
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable startArrow and/or
endArrow.
RectProps.arrowSizeartboardId
artboardId?: SignalValuestringnumber
basis
Inherited from RectProps.basisbottom
bottom?: SignalValuePossibleVector2number
The position of the bottom edge of this node.
This shortcut property will set the node's position so that the bottom edge
ends up in the given place.
If present, overrides the position property.
RectProps.bottombottomLeft
bottomLeft?: SignalValuePossibleVector2number
The position of the bottom left corner of this node.
This shortcut property will set the node's position so that the bottom left
corner ends up in the given place.
If present, overrides the position property.
RectProps.bottomLeftbottomRight
The position of the bottom right corner of this node.
This shortcut property will set the node's position so that the bottom
right corner ends up in the given place.
If present, overrides the position property.
RectProps.bottomRightcache
cache?: SignalValueboolean
RectProps.cachecachePadding
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
RectProps.cachePaddingcachePaddingBottom
cachePaddingBottom?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
RectProps.cachePaddingBottomcachePaddingLeft
cachePaddingLeft?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
RectProps.cachePaddingLeftcachePaddingRight
cachePaddingRight?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
RectProps.cachePaddingRightcachePaddingTop
cachePaddingTop?: SignalValuenumber
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
RectProps.cachePaddingTopchildren
Inherited from RectProps.childrenclip
clip?: SignalValueboolean
RectProps.clipclosed
closed?: SignalValueboolean
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromRectProps.closedcolumnGap
Inherited from RectProps.columnGapcomposite
composite?: SignalValueboolean
RectProps.compositecompositeOperation
compositeOperation?: SignalValueGlobalCompositeOperation
RectProps.compositeOperationcornerSharpness
cornerSharpness?: SignalValuenumber
Controls the sharpness of smoothCorners.
This property only affects the way rounded corners are drawn. To control
the corner radius use the radius property.
Requires smoothCorners to be enabled to have any effect.
By default, corner sharpness is set to 0.6 which represents a smooth,
circle-like rounding. At 0 the edges are squared off.
RectProps.cornerSharpnessdirection
Inherited from RectProps.directionend
end?: SignalValuenumber
A percentage from the start after which the curve should be clipped.
The portion of the curve that comes after the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0 means the very start of the curve (accounting for the
startOffset) while 1 means the very end (accounting for the
endOffset).
RectProps.endendArrow
endArrow?: SignalValueboolean
Whether to display an arrow at the end of the visible curve.
Use arrowSize to control the size of the arrow.
RectProps.endArrowendOffset
endOffset?: SignalValuenumber
The offset in pixels from the end of the curve.
This property lets you specify where along the defined curve the actual
visible portion ends. For example, setting it to 20 will make the last
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use end
instead.
RectProps.endOffsetfill
Inherited from RectProps.fillfilters
Inherited from RectProps.filtersfontFamily
fontFamily?: SignalValuestring
RectProps.fontFamilyfontSize
fontSize?: SignalValuenumber
RectProps.fontSizefontStyle
fontStyle?: SignalValuestring
RectProps.fontStylefontWeight
fontWeight?: SignalValuenumber
RectProps.fontWeightgap
Inherited from RectProps.gapgrow
grow?: SignalValuenumber
RectProps.growheight
Inherited from RectProps.heightjustifyContent
Inherited from RectProps.justifyContentkey
key?: string
RectProps.keylayout
Inherited from RectProps.layoutleft
left?: SignalValuePossibleVector2number
The position of the left edge of this node.
This shortcut property will set the node's position so that the left edge
ends up in the given place.
If present, overrides the position property.
RectProps.leftletterSpacing
letterSpacing?: SignalValuenumber
RectProps.letterSpacinglineCap
lineCap?: SignalValueCanvasLineCap
RectProps.lineCaplineDash
lineDash?: SignalValuenumber[]
RectProps.lineDashlineDashOffset
lineDashOffset?: SignalValuenumber
RectProps.lineDashOffsetlineHeight
Inherited from RectProps.lineHeightlineJoin
lineJoin?: SignalValueCanvasLineJoin
RectProps.lineJoinlineWidth
lineWidth?: SignalValuenumber
RectProps.lineWidthmargin
Inherited from RectProps.marginmarginBottom
marginBottom?: SignalValuenumber
RectProps.marginBottommarginLeft
marginLeft?: SignalValuenumber
RectProps.marginLeftmarginRight
marginRight?: SignalValuenumber
RectProps.marginRightmarginTop
marginTop?: SignalValuenumber
RectProps.marginTopmaxHeight
Inherited from RectProps.maxHeightmaxWidth
Inherited from RectProps.maxWidthmiddle
middle?: SignalValuePossibleVector2number
The position of the center of this node.
This shortcut property will set the node's position so that the center ends
up in the given place.
If present, overrides the position property.
When offset is not set, this will be the same as the
position.
RectProps.middleminHeight
Inherited from RectProps.minHeightminWidth
Inherited from RectProps.minWidthoffset
offset?: SignalValuePossibleVector2number
RectProps.offsetoffsetX
offsetX?: SignalValuenumber
RectProps.offsetXoffsetY
offsetY?: SignalValuenumber
RectProps.offsetYopacity
opacity?: SignalValuenumber
RectProps.opacitypadding
Inherited from RectProps.paddingpaddingBottom
paddingBottom?: SignalValuenumber
RectProps.paddingBottompaddingLeft
paddingLeft?: SignalValuenumber
RectProps.paddingLeftpaddingRight
paddingRight?: SignalValuenumber
RectProps.paddingRightpaddingTop
paddingTop?: SignalValuenumber
RectProps.paddingTopposition
position?: SignalValuePossibleVector2number
RectProps.positionradius
Rounds the corners of this rectangle.
The value represents the radius of the quarter circle that is used to round the corners. If the value is a number, the same radius is used for all corners. Passing an array of two to four numbers will set individual radii for each corner. Individual radii correspond to different corners depending on the number of values passed:
// top-left-and-bottom-right | top-right-and-bottom-left
[10, 30]
// top-left | top-right-and-bottom-left | bottom-right
[10, 20, 30]
// top-left | top-right | bottom-right | bottom-left
[10, 20, 30, 40]
RectProps.radiusratio
ratio?: SignalValuenumber
RectProps.ratioref
ref?: ReferenceReceiverany
RectProps.refright
right?: SignalValuePossibleVector2number
The position of the right edge of this node.
This shortcut property will set the node's position so that the right edge
ends up in the given place.
If present, overrides the position property.
RectProps.rightrotation
rotation?: SignalValuenumber
RectProps.rotationrowGap
Inherited from RectProps.rowGapscale
scale?: SignalValuePossibleVector2number
RectProps.scalescaleX
scaleX?: SignalValuenumber
RectProps.scaleXscaleY
scaleY?: SignalValuenumber
RectProps.scaleYshaders
shaders?: PossibleShaderConfig
RectProps.shadersshadowBlur
shadowBlur?: SignalValuenumber
RectProps.shadowBlurshadowColor
Inherited from RectProps.shadowColorshadowOffset
Inherited from RectProps.shadowOffsetshadowOffsetX
shadowOffsetX?: SignalValuenumber
RectProps.shadowOffsetXshadowOffsetY
shadowOffsetY?: SignalValuenumber
RectProps.shadowOffsetYshrink
shrink?: SignalValuenumber
RectProps.shrinksize
Inherited from RectProps.sizeskew
skew?: SignalValuePossibleVector2number
RectProps.skewskewX
skewX?: SignalValuenumber
RectProps.skewXskewY
skewY?: SignalValuenumber
RectProps.skewYsmoothCorners
smoothCorners?: SignalValueboolean
Enables corner smoothing.
This property only affects the way rounded corners are drawn. To control
the corner radius use the radius property.
When enabled, rounded corners are drawn continuously using Bézier curves
rather than quarter circles. The sharpness of the curve can be controlled
with cornerSharpness.
You can read more about corner smoothing in this article by Nick Lawrence.
Inherited fromRectProps.smoothCornersspawner
Deprecated
Use children instead.
RectProps.spawnersrc
src?: SignalValuestring
start
start?: SignalValuenumber
A percentage from the start before which the curve should be clipped.
The portion of the curve that comes before the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0 means the very start of the curve (accounting for the
startOffset) while 1 means the very end (accounting for the
endOffset).
RectProps.startstartArrow
startArrow?: SignalValueboolean
Whether to display an arrow at the start of the visible curve.
Use arrowSize to control the size of the arrow.
RectProps.startArrowstartOffset
startOffset?: SignalValuenumber
The offset in pixels from the start of the curve.
This property lets you specify where along the defined curve the actual
visible portion starts. For example, setting it to 20 will make the first
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use start
instead.
RectProps.startOffsetstroke
Inherited from RectProps.strokestrokeFirst
strokeFirst?: SignalValueboolean
RectProps.strokeFirsttagName
tagName?: keyof HTMLElementTagNameMap
RectProps.tagNametextAlign
textAlign?: SignalValueCanvasTextAlign
RectProps.textAligntextDirection
textDirection?: SignalValueCanvasDirection
RectProps.textDirectiontextWrap
Inherited from RectProps.textWraptop
top?: SignalValuePossibleVector2number
The position of the top edge of this node.
This shortcut property will set the node's position so that the top edge
ends up in the given place.
If present, overrides the position property.
RectProps.toptopLeft
topLeft?: SignalValuePossibleVector2number
The position of the top left corner of this node.
This shortcut property will set the node's position so that the top left
corner ends up in the given place.
If present, overrides the position property.
RectProps.topLefttopRight
topRight?: SignalValuePossibleVector2number
The position of the top right corner of this node.
This shortcut property will set the node's position so that the top right
corner ends up in the given place.
If present, overrides the position property.
RectProps.topRightwidth
Inherited from RectProps.widthwrap
Inherited from RectProps.wrapx
x?: SignalValuenumber
RectProps.xy
y?: SignalValuenumber
RectProps.yzIndex
zIndex?: SignalValuenumber
RectProps.zIndex