Skip to main content

JQuery oembed plistred in the Plone resource registry

Project description

Introduction

This addon register the jquery plugin oembed in the Plone resource registry.

Version: 1.1.0 RC

How to use jquery.oembed

Explicit example:

<script type="text/javascript">
$(document).ready(function() {
        $("#container").oembed("http://www.flickr.com/photos/14516334@N00/345009210/");
});
</script>
<div id="container"></div>

Implicit example:

<script type="text/javascript">
        $(document).ready(function() {
                $("a.oembed").oembed();
        });
</script>
<div><a href="http://www.flickr.com/photos/14516334@N00/345009210/" class="oembed">Flickr Image</a></div>
<div><a href="http://vimeo.com/3108686" class="oembed">Vimeo Video</a></div>

Configuring multiple providers example

<script type="text/javascript">
        $(document).ready(function() {
                $(".oembed").oembed(null,
                        {
                        embedMethod: "append",
                        maxWidth: 1024,
                        maxHeight: 768,
                        vimeo: { autoplay: true, maxWidth: 200, maxHeight: 200}
                        });
        });
</script>
<div><a href="http://vimeo.com/3108686" class="oembed">Vimeo Video</a></div>
<div><a href="http://www.flickr.com/photos/14516334@N00/345009210/" class="oembed">Flickr Image</a></div>

Supported OEmbed providers

  • 5min

  • Amazon Product Images

  • Flickr

  • Google Video

  • Hulu

  • Imdb

  • Metacafe

  • Myspace Videos

  • Qik

  • Revision3

  • Screenr

  • Slideshare

  • Twitpic

  • Viddler

  • vVimeo

  • Wikipedia

  • WordPress

  • YouTube

This javascript plugin relays in ‘jsonp’, so only oEmbed providers that support callback methods are directly implemented.

Any other oEmbed provider uses embedly service.

How to manage providers

‘greedy’ option let you activate a fallback service to not natively supported services, by default the service used is oohembed.

allowed providers:

$(".oembed").oembed(null, { allowedProviders: ["flickr", "youtube"] });

custom providers:

$(".oembed").oembed(null, {
    greedy: false,
    customProviders: [{
        "name": "streetfire.net",
        "urlschemes": ["streetfire\\.net\/video\/.*"],
        "apiendpoint": "http://api.embed.ly/v1/api/oembed?"
    }]
});

disallowed providers:

$(".oembed").oembed(null, { disallowedProviders: ["flickr", "youtube"] });

default oembed provider:

$(".oembed").oembed(null, {defaultOEmbedProvider: "embed.ly"});

embeded method

append:

$(".oembed").oembed(null, {embedMethod: "append"});

It append to the .oembed container the result with a container classified:

<a href="..." class="oembed">...</a>
<div class="oembed-container oembed-container-Vimeo">...</div>

fill:

$(".oembed").oembed(null, {embedMethod: "fill"});

It fill the link with the results:

<a href="..." class="oembed">
  <div>...</div>
</a>

replace:

$(".oembed").oembed(null, {embedMethod: "replace"});

It replaces the link with the html snippet

manage size

You can add a size constraint to the html snippet. You can set maxWidth and/or maxHeight:

$(".oembed").oembed(null, {
        maxWidth: 400,
        maxHeight: 300 });
});

Credits

Companies

makinacom

Authors

Changelog

1.0a (2012-01-02)

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.js.oembed-1.0a.tar.gz (12.2 kB view details)

Uploaded Source

File details

Details for the file collective.js.oembed-1.0a.tar.gz.

File metadata

File hashes

Hashes for collective.js.oembed-1.0a.tar.gz
Algorithm Hash digest
SHA256 f1d984a2cb5071e8bca1ce259cf593ee21130ba4805ea3be0e10295fd7c906ff
MD5 303ca0e6c1d06176c03b08d8de08e22d
BLAKE2b-256 172e4eab04a90c6189a508fba4bd54c9937240d93d48571b38eb1b2e708b3f57

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page