Video
Start playing videos as they are shown or enter the viewport.
The Video component offers two advanced functions for videos. First, it allows you to pause a video whenever it's hidden with CSS and resume playing once it becomes visible again. In addition, the video can pause when it's outside the viewport and start playing when entering it.
Secondly, it allows you to mute YouTube and Vimeo videos, which is often needed if they are used as the background of a section.
For example, the Slideshow, Lightbox and Cover components inherit and make use of both functions.
# Usage
To apply this component, add the uk-video attribute to a <video> element. The video will be paused whenever it's hidden with CSS and resume once it becomes visible again.
<video src="" width="" height="" uk-video></video>
<button class="uk-button uk-button-default uk-margin" type="button" uk-toggle="target: +">Toggle HTML5 Video</button>
<video src="https://yootheme.com/site/images/media/yootheme-pro.mp4" width="1920" height="1080" controls playsinline hidden uk-video></video>
# Autoplay inview
To play a video when it enters the viewport and pause it again when it leaves the viewport, just add the uk-video="autoplay: inview" attribute to a <video> element.
<video src="" width="" height="" uk-video="autoplay: inview"></video>
<video src="https://yootheme.com/site/images/media/yootheme-pro.mp4" width="1800" height="1200" loop muted playsinline uk-video="autoplay: inview"></video>
# Automute YouTube or Vimeo
To mute YouTube or Vimeo videos by default, add the uk-video="automute: true" attribute to the <iframe> element.
<iframe src="" width="" height="" uk-video="automute: true"></iframe>
<button class="uk-button uk-button-default uk-margin-bottom" type="button" uk-toggle="target: +">Toggle YouTube Video</button>
<iframe src="https://www.youtube-nocookie.com/embed/c2pz2mlSfXA?autoplay=0&showinfo=0&rel=0&modestbranding=1&playsinline=1" width="1920" height="1080" allowfullscreen uk-responsive uk-video="automute: true"></iframe>
# Component options
The table below lists the available settings of the uk-video attribute. Learn more
| Option | Value | Default | Description |
|---|---|---|---|
autoplay | Boolean, String | true | The video automatically plays/pauses as it's visible/hidden on the page. A value of inview will delay loading the video and play/pause the video as it enters/leaves the viewport. |
automute | Boolean | false | Automatically mute YouTube or Vimeo videos. |
autoplay is the Primary option, and its key may be omitted if it's the only option in the attribute value.
# JavaScript
Learn more about JavaScript components.
# Initialization
UIkit.video(element, options);
← Utility Visibility →