JoshuaGross / posthog-react-rrweb-player

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

@posthog/react-rrweb-player

React-based player for rrweb

NPM JavaScript Style Guide

Install

npm install --save @posthog/react-rrweb-player

Usage

import React, { Component } from 'react'

import { EventIndex, formatTime, PlayerRef, PlayerContextProvider, PlayerController, PlayerFrame } from '@posthog/react-rrweb-player'
import '@posthog/react-rrweb-player/dist/index.css'

class Example extends Component {
    render() {
        return (
            <PlayerContextProvider
                ref={ref}
                events={events}
                key={recording.key}
                onPlayerTimeChange={() => {}}
                onNext={() => {}}
                onPrevious={() => {}}
                duration={duration}
                isBuffering={false}
            >
                <PlayerFrame />
                <PlayerController />
            </PlayerContextProvider>
        )
    }
}

Developing locally

To develop locally, you can run the following commands and an example app will be launched on port 3000.

yarn # only the first time to install dependencies
yarn start # to run the base component
cd example
yarn start # to run the example project

Questions?

About

License:MIT License


Languages

Language:TypeScript 90.0%Language:SCSS 4.9%Language:HTML 4.1%Language:CSS 0.9%