npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mycujoo/player-core

v1.1.7-rc.0

Published

Based on video.js project

Downloads

66

Readme

Player core

Based on video.js project

Dependencies

This project's advanced features and some of the core features will require these packages to be used in your project:

react
react-dom
@emotion/react
prop-types
lodash

Usage

To use Player core in a React project, all you need is to install this package:

yarn add @mycujoo/player-react

The minimal setup will look like this:

import Player from '@mycujoo/player-core'
....
// render method of your component
<Player source="path-to-file" />

API

| Prop | Type | Description | | --------------- | :------: | -------------------------------------------------------------------------------------- | | source | string | Path to m3u8 or mp4 video source, required | | autoplay | bool | html5 video tag autoplay attribute | | controls | bool | html5 video tag constrols attribute | | playsInline | bool | html5 video tag playsInline attribute | | qualitySelector | bool | Determines if quality selector should be used or not | | debug | bool | Toggles debug mode, if it is on video.js | | onError | function | Is triggered when video.js throws an error, see vjs errors documentation for more info | | onClick | function | Is triggered when clicking on the player wrapper | | onPlayerActive | function | Is triggered when video is playing every 5 seconds to report healthy playback | | onVideoPlay | function | Is triggered on html5 video tag play event | | onVideoPause | function | Is triggered on html5 video tag pause event | | onVideoSeek | function | Is triggered on html5 video tag seek event | | onVideoStart | function | Is triggered on first occurence of html5 video tag play event | | onVideoEnd | function | Is triggered on html5 video tag end event | | onVideoJsInit | function | Is triggered after video.js class is instantiated. The instance is passed as a param |

Additionaly the library also exports some videojs generic components that can be used as follows:

import Player, { CustomFullScreenButton, TotalViewers, WatchOnLink } '@mycujoo/player-core'
(props) => {
    const [playerInstance, setPlayerInstance] = useState(null)
    const { totalViewers, isLive } = props

    <Player {...props} onVideoJsInit={instance => setPlayerInstance(instance)}>
        <TotalViewers
            player={playerInstance}
            label=""
            totalViewers={totalViewers}
            show={isLive}
        />
        <CustomFullScreenButton
            player={playerInstance}
            setFullscreen={isFS => console.log(`Player is ${isFS? 'fullscreen' : 'inline'}`)}
        />
        <WatchOnLink
            player={playerInstance}
            url='//external.url.link'
            target = '_blank' // default
            logo = '//logo.url',
            title = 'Watch on MLS',
        />
    </Player>
}

Development

To set up development environment for this project you will need to link player package inside you project, but also link all peer dependencies from you project inside player.

So the steps are following:

  1. Run yarn link inside @mycujoo/player-core repository
  2. Go to your project root and run yarn link @mycujoo/player-core
  3. Go to each of the dependeincy package inside your project's node_modules and run yarn link
  4. Go to @mycujoo/player-core repository again and run yarn link react react-dom @emotion/react prop-types lodash

To speed up the build, make sure that terser and visualizer are disabled in rollupConfig, development config would be created in the future.

To deploy new version to npm: Make sure the version in package.json is updated, then create new tag with version format and push it to the repo:

git tag v1.0.50 -am 'version 50 message'
git push origin v1.0.50

This will trigger a job in CircleCI that will run npm publish and push the changes to npm. Alternatively you can just update the version in package.json and then run npm publish to publish the bundle.

Tests

Run yarn test to run tests.