Skip to content

magic-modules/video-embed

Repository files navigation

@magic-modules/video-embed

this is the @magic-modules VideoEmbed component. it renders videos from any http url that allows iframe embedding.

html docs and demo

NPM version Linux Build Status Windows Build Status Coverage Status Greenkeeper badge Known Vulnerabilities

installation

npm install @magic-modules/video-embed

usage

youtube

in a page/component, just pass a video id to the VideoEmbed module.

VideoEmbed('ecIWPzGEbFc')

vimeo

if the video id is a number, the video is assumed to be hosted on vimeo

VideoEmbed(153090637)
VideoEmbed('153090637')

other video hosts

videos from arbitrary hosts can be included as well, as long as those hosts allow iframe embeds',

VideoEmbed('https://videopress.com/embed/kUJmAcSf')

props

you can pass a width and height, a style object and any other props to the video.'),

VideoEmbed({ src: '8QYWGCEm2Dc', width: '50%', style: { margin: 1em 0 0; } })

fixed video dimensions

to set a fixed video size, simply add both a height and a width value (px, em, rem, vh, pt).

  VideoEmbed({ src: 'SMhwddNQSWQ', width: '300px', height: '900px' }),

changelog

0.0.1

first release

0.0.2

update docs

0.0.3
  • require node 13.5.0
  • ready for markdown
0.0.4

bump required node version to 14.2.0

0.0.5

bump required node version to 14.15.4

0.0.6

BREAKING: rename props.src to props.id

0.0.7 - unreleased

...