Nonvoluntary Professional Mangling

    @grewer/reactjs-player
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.4 • Public • Published

    ReactPlayer

    ReactPlayer

    npm reactjs-player Travis (.org) Coveralls github

    基于 react hooks 的 video 播放组件,结构简单,代码简洁,扩展方便。

    特点

    ReactPlayer 遵循 少即是多(Less is more) 的设计原则,具有以下特点:

    • 结构简单:使用 react hooks 做状态管理,将不同的状态拆分到不同的 react custom hooks 中,ReactPlayer 中进行组合
    • 扩展方便:扩展时实现对应的 react custom hooks 并在 ReactPlayer 中根据条件进行加载
    • 代码简洁:只做播放器内部的状态管理和控制栏显示与控制
    • 理解容易: ReactPlayer 事件基于 vidoe 媒体事件 进行扩展,减小理解成本
    • 使用相对复杂:不同于其他的 h5 播放器,ReactPlayer 将控制权交给使用者,无法做到一行代码播放所有兼容的格式

    Getting started

    git clone https://github.com/goblin-laboratory/reactjs-player.git
    cd reactjs-player
    yarn install
    cd packages/reactjs-player
    yarn start
    

    Usage

    Demo page: https://goblin-laboratory.github.io/reactjs-player/

    npm install reactjs-player --save
    # or
    yarn add reactjs-player
    
    import React, { Component } from 'react';
    import ReactPlayer from 'reactjs-player';
    
    const App = () => {
      return (
        <ReactPlayer
          kernel="hlsjs"
          src="https://video-dev.github.io/streams/x36xhzz/x36xhzz.m3u8"
          type="application/x-mpegURL"
        />
      );
    };

    常用场景见说明文档:Usage.md

    API

    见 API 说明文档:API.md

    Supported media

    • HLS
    • FLV
    • RTMP
    • MP4

    微信同层播放

    待补充

    Contributing

    非常欢迎你的贡献,你可以通过以下方式和我们一起共建 😃

    • 通过 Issue 报告 bug 或进行咨询。
    • 提交 Pull Request 。

    Licensing

    ReactPlayer is MIT licensed.

    Install

    npm i @grewer/reactjs-player

    DownloadsWeekly Downloads

    6

    Version

    1.2.4

    License

    MIT

    Unpacked Size

    3.76 MB

    Total Files

    39

    Last publish

    Collaborators

    • avatar