YouTube
Deprecated
We recommend you to use VidStack for better experience.
Embed YouTube videos in Markdown files.
Demo
<YouTube list-type="playlist" list="PLJNLwTPak6dhCRzVelZIs2-DfBp01NX_1" />
Props
id
- Type:
string
- Required: Yes
YouTube video id
Note
It is ONLY not required, when you are setting listType
to "playlist"
and provide a valid playlist id using list
.
title
- Type:
string
- Required: No
YouTube video title
width
- Type:
string | number
- Default:
100%
YouTube component width.
height
- Type:
string | number
- Required: No
YouTube component height
ratio
- Type:
number
- Default:
16 / 9
YouTube component ratio, ONLY valid when height
not set.
autoplay
- Type:
boolean
- Default:
false
Whether autoplay the video.
loop
- Type:
boolean
- Default:
false
Whether loop the video.
showCc
- Type:
boolean
- Default:
false
Whether display captions.
showAnnotations
- Type:
boolean
- Default:
false
Whether show annotations of the video.
start
- Type:
number
- Required: No
Start time of the video (in seconds).
end
- Type:
number
- Required: No
End time of the video (in seconds).
Note
This time is counted from the beginning of the video.
defaultCcLang
- Type:
string
- Default:
page.lang
Default caption language.
uiLang
- Type:
string
- Default:
page.lang
UI language.
listType
- Type:
"playlist" | "search" | ""
- Default:
""
List type.
list
- Type:
string
- Required: No
List value.
playlist
- Type:
string
- Required: No
Play list id.
disableControls
- Type:
boolean
- Default:
false
Whether disable controls of the video.
disableFullscreen
- Type:
boolean
- Default:
false
Whether disable fullscreen button of the video.
disableKeyboard
- Type:
boolean
- Default:
false
Whether disable keyboard control of the video.