1.0.1 • Published 1 year ago

custom-rn-youtube-player v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

npm version code style: prettier

YouTubePlayer Component

The YouTubePlayer component is a customizable YouTube player built using React Native and the WebView component. It allows you to embed YouTube videos in your React Native application with various customization options.

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Table of contents

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the library, run:

$ npm install react-native-webview
$ npm i custom-rn-youtube-player

Usage

Serving the app

$ npm start

Running the tests

$ npm test

Example:

import React from 'react';
import { View } from 'react-native';
import YouTubePlayer from 'custom-rn-youtube-player';

const App = () => {
 const video_id='N3oCS85HvpY';
  return (
    <View>
      <YouTubePlayer
        videoSource={video_id}
        autoPlay={true}
        playButtonColor="#FF0000"
        hideYTLogo={true}
        hideTopBar={true}
        width="100%"
        height={300}
        onError={() => console.log('Error loading video')}
      >
      </YouTubePlayer>
    </View>
  );
};

export default App;

props

Prop NameTypeDefaultDescription
videoSourceString"_CuSlwOmDOo"The source URL or video ID of the YouTube video.
startVideoFromNumber0The time (in seconds) from which the video should start playing.
autoPlayBooleanfalseWhether the video should start playing automatically.
playButtonColorString"#000000"The color of the play button.
hideYTLogoBooleanfalseWhether to hide the YouTube logo.
hideTopBarBooleanfalseWhether to hide the top bar of the player.
hideControlsBooleanfalseWhether to hide the player controls.
hideCardsBooleanfalseWhether to hide video suggestion cards.
widthString or Number"100%"The width of the player.
heightString or Number200The height of the player.
onErrorFunctionnullCallback function to handle errors.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Add your changes: git add .
  4. Commit your changes: git commit -am 'Add some feature'
  5. Push to the branch: git push origin my-new-feature
  6. Submit a pull request :sunglasses:

Authors

  • Sumit Nayak
1.0.1

1 year ago

1.0.0

1 year ago