diff --git a/.npmignore b/.npmignore index 30d29de..07f00f9 100644 --- a/.npmignore +++ b/.npmignore @@ -1 +1,2 @@ -doc/* +docs/* +website/* diff --git a/doc/readme.md b/doc/readme.md deleted file mode 100644 index af48eef..0000000 --- a/doc/readme.md +++ /dev/null @@ -1,404 +0,0 @@ -# - -## Example - -```JSX - console.log(event)} - onReady={() => console.log("ready")} - onError={e => console.log(e)} - onFullScreenChange={status => console.log(status)} - onPlaybackQualityChange={q => console.log(q)} - volume={50} - playbackRate={1} - initialPlayerParams={{ - preventFullScreen: true, - cc_lang_pref: "us", - showClosedCaptions: true - }} -/> -``` - -## Index - -### props - -- [height](#height) -- [width](#width) -- [ref](#ref) -- [videoId](#videoId) -- [playList](#playList) -- [playListStartIndex](#playListStartIndex) -- [play](#play) -- [onChangeState](#onChangeState) -- [onReady](#onReady) -- [onError](#onError) -- [onFullScreenChange](#onFullScreenChange) -- [onPlaybackQualityChange](#onPlaybackQualityChange) -- [mute](#mute) -- [volume](#volume) -- [playbackRate](#playbackRate) -- [onPlaybackRateChange](#onPlaybackRateChange) -- [initialPlayerParams](#initialPlayerParams) -- [webViewStyle](#webViewStyle) -- [webViewProps](#webViewProps) -- [forceAndroidAutoplay](#forceAndroidAutoplay) -- [allowWebViewZoom](#allowWebViewZoom) - -### Ref functions - -- [getDuration](#getDuration) -- [getCurrentTime](#getCurrentTime) -- [isMuted](#isMuted) -- [getVolume](#getVolume) -- [getPlaybackRate](#getPlaybackRate) -- [getAvailablePlaybackRates](#getAvailablePlaybackRates) -- [seekTo](#seekTo) - -### module methods - -- [getYoutubeMeta](#getYoutubeMeta) - -# Reference - -## height - -**REQUIRED, _Number_** - -height of the webview container - -## width - -**REQUIRED, _Number_** - -width of the webview container - -> Note: Embedded players must have a viewport that is at least 200px by 200px. If the player displays controls, it must be large enough to fully display the controls without shrinking the viewport below the minimum size. We recommend 16:9 players be at least 480 pixels wide and 270 pixels tall. - -## ref - -Gives access to the player reference. This can be used to access player functions. - -```javascript -import React, {useRef} from 'react'; -const App = () => { - const playerRef = useRef(); - return ( - -