属性
新版运行时(推荐)
以下是您可以在 RiveView 组件上设置的属性:
file—RiveFile,必需。要显示的 riv 文件,通过useRiveFile或RiveFileFactory加载。hybridRef—HybridView。视图引用设置器,从useRive获取。autoPlay—boolean,默认true。自动开始播放状态机。fit—Fit,默认Contain。Rive 图形在其容器内的适配方式。alignment—Alignment,默认Center。Rive 图形在其容器内的对齐方式。使用
Fit.Layout时忽略。layoutScaleFactor—double,默认-1。使用Fit.Layout时应用于 Rive 图形的缩放因子。默认值-1使用设备的 DPI。此属性对其他
Fit类型无效。artboardName—String。要显示的画板名称。如果未设置,将使用编辑器中配置的默认画板。stateMachineName—String。要播放的状态机名称。如果未设置,将使用编辑器中配置的默认状态机。dataBind—ViewModelInstance | DataBindMode | DataBindByName,默认DataBindMode.Auto。要绑定到状态机的视图模型实例。可以是:ViewModelInstance对象(来自useViewModelInstance)DataBindMode.Auto(默认)— 自动绑定默认视图模型实例DataBindMode.None— 无数据绑定{ byName: string }— 按实例名称绑定 参见数据绑 定文档了解更多详情。
onError—((error: RiveError) => void)。自定义错误处理回调。
旧版运行时
以下是您可以在旧版运行时的 Rive React 组件上设置的属性:
children(可选) — 可用于在 Rive 动画视图上绝对定位显示某些内容。style(可选) — Rive 动画视图包装器的样式。- 默认:
undefined - 类型:
StyleProp<ViewStyle>
- 默认:
resourceName(可选) — 匹配 Rive 文件(不带.riv扩展名)的文件名。应提供resourceName或url之一,不能同时提供两者。- 默认:
undefined - 类型:
string
- 默认:
url(可选) — 提供 Rive 文件的 URL。应提供resourceName或url之一,不能同时提供两者。- 默认:
undefined - 类型:
string
- 默认:
autoplay(可选) — 打开 Rive 动画视图或指定新的resourceName或url时,将在准备就绪后自动播放。- 默认:
true - 类型:
boolean
- 默认:
fit(可选) — 指定动画在 Rive 动画视图内的显示方式。- 默认:
Fit.Contain - 类型:
Fit
- 默认:
alignment(可选) — 指定动画在 Rive 动画视图内的对齐方式。- 默认:
Alignment.None - 类型:
Alignment
- 默认:
artboardName(可选) — 指定应在 Rive 动画视图中显示哪个动画画板。- 默认:
undefined - 类型:
string
- 默认:
animationName(可选) — 指定当autoplay设置为true时应播放哪个动画。- 默认:
undefined - 类型:
string
- 默认:
stateMachineName(可选) — 指定当autoplay设置为true时应播放哪个状态机。- 默认:
undefined - 类型:
string
- 默认:
testID(可选) — 指定 testID,在测试中很有用。- 默认:
undefined - 类型:
string
- 默认:
onPlay(可选) — 当动画或状态机启动时调用的回调函数。- 类型:
(animationName: string, isStateMachine: boolean) => void
- 类型:
onPause(可选) — 当动画或状态机暂停时调用的回调函数。- 类型:
(animationName: string, isStateMachine: boolean) => void
- 类型:
onStop(可选) — 当动画或状态机停止时调用的回调函数。- 类型:
(animationName: string, isStateMachine: boolean) => void
- 类型:
onLoopEnd(可选) — 当动画循环结束时调用的回调函数。注意: 此回调仅在通过animationName属性播放单个动画时调用,通过stateMachineName属性播放状态机时不会调用。- 类型:
(animationName: string, loopMode: LoopMode) => void
- 类型:
onStateChanged(可选) — 当内部动画状态更改时调用的回调函数。与状态机功能紧密耦合。- 类型:
(stateMachineName: string, stateName: string) => void
- 类型:
onError(可选) — 当抛出错误时调用的回调函数。允许手动处理由RNRiveError描述的抛出错误。- 类型:
(riveError: RNRiveError) => void
- 类型:
onRiveEventReceived(可选) — 当渲染循环报告 Rive 事件时调用的回调函数。- 类型:
(event: RiveGeneralEvent | RiveOpenUrlEvent) => void
- 类型: