Skip to content

Commit 8339931

Browse files
committed
fix: restore full JSDoc on RiveView
1 parent 91a4d2b commit 8339931

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

src/core/RiveView.tsx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,20 @@ const defaultOnError = (error: RiveError) =>
2727
* style={styles.riveContainer}
2828
* />
2929
* ```
30+
*
31+
* @property {RiveFile} file - The Rive file to be displayed
32+
* @property {string} [artboardName] - Name of the artboard to display from the Rive file
33+
* @property {string} [stateMachineName] - Name of the state machine to play
34+
* @property {ViewModelInstance | DataBindMode | DataBindByName} [dataBind] - Data binding configuration for the state machine, defaults to DataBindMode.Auto
35+
* @property {boolean} [autoPlay=true] - Whether to automatically start playing the state machine
36+
* @property {Alignment} [alignment] - How the Rive graphic should be aligned within its container
37+
* @property {Fit} [fit] - How the Rive graphic should fit within its container
38+
* @property {Object} [style] - React Native style object for container customization
39+
* @property {(error: RiveError) => void} [onError] - Callback function that is called when an error occurs
40+
*
41+
* The component also exposes methods for controlling playback:
42+
* - play(): Starts playing the Rive graphic
43+
* - pause(): Pauses the Rive graphic
3044
*/
3145
export function RiveView(props: RiveViewProps) {
3246
const { onError, hybridRef: userHybridRef, ...rest } = props;

0 commit comments

Comments
 (0)