@loomhq/loom-embed

SDK for easily embedding videos

Usage no npm install needed!

<script type="module">
  import loomhqLoomEmbed from 'https://cdn.skypack.dev/@loomhq/loom-embed';
</script>

README

npm version CircleCI codecov

Installing

npm package

npm install @loomhq/loom-embed

Script tag

<script type="module"> import * as loom from "https://www.unpkg.com/@loomhq/loom-embed@1.2.4/dist/esm/index.js?module"; </script>

See documentation for installation and usage.

Usage

import * as loom from '@loomhq/loom-embed';

Methods

.linkReplace(selector, [options], target)

Replaces any loom links at the nodes matching the selector with the embedded video. Replacement occurs on the entire document, or on the optional target DOM element.

.textReplace(textString, [options])

Takes a string and replaces any Loom URLs with the embed html

-> returns a promise

.oembed(videoUrl, [options])

oembed metadata from the given video url

-> returns a promise

Options

The embed code is responsive by default. Only set the width/height values if you require your embed code to be a fixed size

width - [Number] value specifying the max pixel width

height - [Number] value specifying the max pixel height