@framini/react-lazy-embed
TypeScript icon, indicating that this package has built-in type declarations

1.0.0-beta.0 • Public • Published

React Lazy Embed

React component for lazy loading heavy embeds like the one from YouTube. For now we only support YouTube videos but we might add support for Vimeo in the short term

Install

With Yarn

yarn install @framini/react-lazy-embed

With NPM

npm install @framini/react-lazy-embed

How it works

The embed can be in 4 possible status, 'idle' | 'visible' | 'load' | 'loaded'.

  • idle: By default it will always starts as idle (in the future we might support an eager mode).
  • visible: Once the embed is within the threshold (by default 200px) it will change it's status to visible. Here is where you can show the video thumbnail and a "play" button. Once the "play" button is pressed status will change to load.
  • load: While the status = load you can safely show the embed (and a loading indicator if you feel like).
  • loaded: When the iframe has been fully loaded.

Example

You can play around with it by running StoryBook.

yarn storybook

Dependencies (0)

    Dev Dependencies (19)

    Package Sidebar

    Install

    npm i @framini/react-lazy-embed

    Weekly Downloads

    0

    Version

    1.0.0-beta.0

    License

    MIT

    Unpacked Size

    64.8 kB

    Total Files

    15

    Last publish

    Collaborators

    • framini