Giter Club home page Giter Club logo

posthog-react-rrweb-player's Introduction

@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?

posthog-react-rrweb-player's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

posthog-react-rrweb-player's Issues

Improve UX of next/previous

If in the current state we're making use of previous/next recordings, and one of the two is not available, show the button but disabled. Currently if there's a next recording available but not a previous one we show only the next button which can be a bit confusing and visually does not look great.

We should however keep the logic that if neither next/previous is available, the buttons should be gone.

Live mode

Thanks for the component, great work!

I'm using rrweb for support to connect to users page in realtime.
I managed to force posthog-react-rrweb-player working in live mode, but it is hacky way:

  • I had to hide toolbar and disable mouse clicks via CSS
  • enabled live mode directly talking to rrweb/replayer and pushed events into it
                    replayerRef.current.replayer.current.config.liveMode = true;
                    replayerRef.current.replayer.current.addEvent(event);
                    replayerRef.current.replayer.current.startLive(event.timestamp);

I think would be good to make it proper way.

rrweb's live mode recipe:
https://github.com/rrweb-io/rrweb/blob/df455c483a294addedd1e325e5e2c534bf0e6013/docs/recipes/live-mode.md

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.