Layout
Controlling the layout of your Rive animation
Rive provides a number of ways to control how your animations are laid out in the canvas or view used to display them. Rive lets you control the fit, alignment, and offset of rendered content.
Most runtimes have a
Layout object that enables you to configure Fit and Alignment. You typically provide layout data when instantiating a Rive object, but you can also update these values at any time.Web
React
Angular
React Native
Flutter
iOS
Android
See values and descriptions in the sections below for
Fit and Alignment.
The runtime has named exports for
Layout, Fit, and Alignment.<div>
<canvas id="canvas" width="800" height="600"></canvas>
</div>
<script src="https://unpkg.com/@rive-app/[email protected]"></script>
<script>
// Fill the canvas, cropping Rive if necessary
let layout = new rive.Layout({
fit: rive.Fit.Cover,
});
// Fit to the width and align to the top of the canvas
layout = new rive.Layout({
fit: rive.Fit.FitWidth,
alignment: rive.Alignment.TopCenter,
});
// Constrain the Rive content to (minX, minY), (maxX, maxY) in the canvas
layout = new rive.Layout({
fit: rive.Fit.Contain,
minX: 50,
minY: 50,
maxX: 100,
maxY: 100,
});
const r = new rive.Rive({
src: 'https://cdn.rive.app/animations/vehicles.riv',
canvas: document.getElementById('canvas'),
layout: layout,
autoplay: true
});
// Update the layout
r.layout = new rive.Layout({ fit: rive.Fit.Fill });
</script>
See values and descriptions in the sections below for
Fit and Alignment.
The runtime has named exports for Layout, Fit, and Alignment.import Rive, { Layout, Fit, Alignment } from '@rive-app/react-canvas';
export const Simple = () => (
<Rive
src="https://cdn.rive.app/animations/vehicles.riv"
layout={new Layout({ fit: Fit.Contain, alignment: Alignment.TopCenter })}
/>
);
With the
useRive hook:import { useRive, Layout, Fit, Alignment } from '@rive-app/react-canvas';
export default function Example() {
const { RiveComponent } = useRive({
src: 'my-file.riv',
artboard: 'my-artboard',
animations: 'my-animation',
layout: new Layout({
fit: Fit.Cover,
alignment: Alignment.TopCenter,
}),
autoplay: true,
});
return <RiveComponent />;
}
Angular runtime exposes the layout's options through inputs on the canvas.
<canvas riv="vehicles" width="500" height="500" fit="fitWidth" alignment="topCenter">
<riv-animation name="idle" play></riv-animation>
</canvas>
Set layout attributes for
Fit and Alignment on the Rive component directly.import Rive, { Alignment, Fit } from 'rive-react-native';
export default function Simple() {
return (
<ScrollView>
<Rive
fit={Fit.Cover}
alignment={Alignment.TopCenter}
resourceName="truck_v7"
/>
</ScrollView>
);
};
Bounds options are absent; Flutter's layout engine and options are the preferred way to handle positioning Rive content.
// Fill the canvas, cropping Rive if necessary
var widget = const RiveAnimation.network(
'https://cdn.rive.app/animations/vehicles.riv',
fit: BoxFit.cover,
);
// Fit to the width and align to the top of the canvas
widget = const RiveAnimation.network(
'https://cdn.rive.app/animations/vehicles.riv',
fit: BoxFit.fitWidth,
alignment: Alignment.topCenter,
);
See values and descriptions in the sections below for
Fit and Alignment.
The runtime provides the following enums to set on layout parameters:
- Fit
.fill.contain.cover.fitWidth.fitHeight.scaleDown.noFit
- Alignment
.topLeft.topCenter.topRight.centerLeft.center.centerRight.bottomLeft.bottomCenter.bottomRight
The following example shows how to set layout parameters and switch them at runtime:
struct SwiftLayout: View {
@State private var fit: RiveFit = .contain
@State private var alignment: RiveAlignment = .center
var body: some View {
VStack {
RiveViewModel(fileName: "fancy_rive_file", fit: fit, alignment: alignment).view()
}
HStack {
Text("Some Fit Examples")
}
HStack {
Button("Fill") { fit = .fill }
Button("Contain") { fit = .contain }
Button("Cover") { fit = .cover }
}
HStack {
Text("Some Alignment Examples")
}
HStack {
Button("Top Left") { alignment = .topLeft }
Button("Top Center") { alignment = .topCenter }
Button("Top Right") { alignment = .topRight }
}
}
}
The following example shows how to set layout parameters and switch them at runtime:
class LayoutViewController: UIViewController {
@IBOutlet weak var riveView: RiveView!
var viewModel = RiveViewModel(fileName: "fancy_rive_file")
override func viewDidLoad() {
viewModel.setView(riveView)
}
@IBAction func fitButtonTriggered(_ sender: UIButton) {
setFit(name: sender.currentTitle!)
}
@IBAction func alignmentButtonTriggered(_ sender: UIButton) {
setAlignment(name: sender.currentTitle!)
}
func setFit(name: String) {
var fit: RiveFit = .contain
switch name {
case "Fill": fit = .fill
case "Contain": fit = .contain
case "Cover": fit = .cover
case "Fit Width": fit = .fitWidth
case "Fit Height": fit = .fitHeight
case "Scale Down": fit = .scaleDown
case "None": fit = .noFit
default: fit = .contain
}
viewModel.fit = fit
}
func setAlignment(name: String) {
var alignment: RiveAlignment = .center
switch name {
case "Top Left": alignment = .topLeft
case "Top Center": alignment = .topCenter
case "Top Right": alignment = .topRight
case "Center Left": alignment = .centerLeft
case "Center": alignment = .center
case "Center Right": alignment = .centerRight
case "Bottom Left": alignment = .bottomLeft
case "Bottom Center": alignment = .bottomCenter
case "Bottom Right": alignment = .bottomRight
default: alignment = .center
}
viewModel.alignment = alignment
}
}
The animation view can be further customized as part of specifying layout attributes.
fit can be specified to determine how the animation should be resized to fit its container. The available choices are FILL , CONTAIN , COVER , FIT_WIDTH , FIT_HEIGHT , NONE , and SCALE_DOWN .alignment informs how it should be aligned within the container. The available choices are TOP_LEFT , TOP_CENTER , TOP_RIGHT , CENTER_LEFT , CENTER , CENTER_RIGHT , BOTTOM_LEFT , BOTTOM_CENTER , and BOTTOM_RIGHT .See more about these values and meanings in the sections below.
Specify the layout values in your Resource layout:
<app.rive.runtime.kotlin.RiveAnimationView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:riveResource="@raw/off_road_car_blog"
app:riveAlignment="TOP_CENTER"
app:riveFit="FILL"
/>
Or in your Activity code:
animationView.fit = Fit.FILL
animationView.alignment = Alignment.CENTER
Fit determines how the Rive content will be fitted to the view. There are a number of options available:
Cover: Rive will cover the view, preserving the aspect ratio. If the Rive content has a different ratio to the view, then the Rive content will be clipped.Contain: (Default) Rive content will be contained within the view, preserving the aspect ratio. If the ratios differ, then a portion of the view will be unused.Fill: Rive content will fill the available view. If the aspect ratios differ, then the Rive content will be stretched.FitWidth: Rive content will fill to the width of the view. This may result in clipping or unfilled view space.FitHeight: Rive content will fill to the height of the view. This may result in clipping or unfilled view space.None: Rive content will render to the size of its artboard, which may result in clipping or unfilled view space.ScaleDown: Rive content is scaled down to the size of the view, preserving the aspect ratio. This is equivalent toContainwhen the content is larger than the canvas. If the canvas is larger, thenScaleDownwill not scale up.
Alignment determines how the content aligns with respect to the view bounds. The following options are available:
Center(Default)TopLeftTopCenterTopRightCenterLeftCenterRightBottomLeftBottomCenterBottomRight
The bounds for the area in which the Rive content will render can be set by providing the minimum and maximum x and y coordinates. These coordinates are relative to the view in which the Rive content is contained, and all must be provided. These will override alignment settings.
minXminYmaxXmaxY
Last modified 3mo ago