Skip to content

A simple, accessible and customisable react media player for Video, Audio, YouTube and Vimeo

License

Notifications You must be signed in to change notification settings

akostiv/plyr-react

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

plyr-react

All Contributors

plyr-react

Installation

This plugin requires minimum Node.js with npm or yarn.

# with npm
npm i plyr-react

# with yarn
yarn add plyr-react

Usage

import Plyr from 'plyr-react'
import 'plyr-react/dist/plyr.css'

export default function App() {
  return (
    <Plyr
      source={
        {
          /* ... */
        }
      }
      options={
        {
          /* ... */
        }
      }
    />
  )
}

Note: You will need mark source as a type of any until a new release of Plyr is available.

Using ref

// Component class
class MyComponent extends Component {
  constructor(props) {
    super(props)
    this.player = createRef()
  }

  componentDidMount() {
    // Access the internal plyr instance
    console.log(this.player.current.plyr)
  }

  render() {
    return (
      <>
        <Plyr ref={(player) => (this.player = player)} />
      </>
    )
  }
}

// Functional component

const MyComponent = () => {
  const ref = useRef()
  useEffect(() => console.log(ref.current.plyr))
  return (
    <>
      <Plyr ref={ref} />
    </>
  )
}

Example

Click here to see example and you can play with this example.

Contribute

Gitpod Ready-to-Code Join the package community on Pika BCH compliance Size

Support

If you like the project and want to support my work, give star or fork it.

Thanks

  • @iwatakeshi For provide help for convert to typescript.

Contributors ✨

Thanks goes to these wonderful people (emoji key):


mnervik

🐛

Takeshi

🤔 💬 🌍 📓 💡 🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

About

A simple, accessible and customisable react media player for Video, Audio, YouTube and Vimeo

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 60.7%
  • JavaScript 39.3%