floedelmann / embetty-vue Goto Github PK

9.0 4.0 5.0 1.5 MB

Embetty displays remote content like tweets or YouTube videos without compromising your privacy.

JavaScript 26.76% HTML 1.90% Vue 69.16% SCSS 2.18%

embetty privacy vue vuejs video twitter hacktoberfest tweets youtube vimeo

embetty-vue's Introduction

embetty-vue

Embetty displays remote content like tweets or videos without compromising your privacy.

This is a Vue.js alternative to the original embetty implementation (which is based on Web Components). To use it, you need to have a embetty server up and running.

Usage

Setup when using a bundler (webpack, rollup, etc.)

import Vue from 'vue';
import EmbettyVue from 'embetty-vue';

const Vue = require('vue');
const { EmbettyVue } = require('embetty-vue');

Vue.use(EmbettyVue, {
  // optional, but recommended
  serverUrl: '/path/to/embetty-server', // without trailing slash

  // optional
  posterImageMode: 'cover' // or 'contain'
});

The CSS can be imported from embetty-vue/dist/embetty-vue.css.

Setup when directly linking the files

In your HTML head:

<link rel="stylesheet" type="text/css" href="dist/embetty-vue.min.css" />
<meta data-embetty-server="/path/to/embetty-server" /> <!-- without trailing slash -->
<script type="text/javascript" src="vue.js"></script>
<script type="text/javascript" src="dist/embetty-vue.browser.min.js"></script>

You can link to the files without .min for debugging.

Using the components

<embetty-tweet status="928365837123227654" />
<embetty-video type="youtube" video-id="m6UOo2YGbIE" />

If you didn't specify the server URL globally (either the options passed to Vue.use or the <meta> tag), you must specify it on every component:

<embetty-tweet server-url="/path/to/embetty-server" status="928365837123227654" />
<embetty-video server-url="/path/to/embetty-server" type="youtube" video-id="m6UOo2YGbIE" />

See src/App.vue for a lot of examples and component options.

Differences to original implementation

embetty-vue's <embetty-video> component supports type native: Provide an URL to a video file as video-id to load it on click in a <video> HTML element.

Development

Project setup

npm install

Compiles and hot-reloads for development

npm run watch

Compiles and minifies for production

npm run build

embetty-vue's People

Contributors

Stargazers

Watchers

Forkers

luckyrumo capesepias hayk44dev reed665 franciscoemanuel

embetty-vue's Issues

Error handling

Embetty server down
Wrong response code
Twitter not authorized
Wrong returned data format

Migrate from rollup to Vite

The rollup plugin for Vue is deprecated and it is suggested to switch to Vite instead. Since Vite is much faster and easier to work with, it makes sense anyway.

Compatibility with both Vue 2 and Vue 3

Maybe with vue-demi, preferably without having to install @vue/composition-api.

Requirements: Needs to work with Vue 2.6, Vue 2.7 and Vue 3.

Maybe needs #333.

Migrate from JavaScript to TypeScript

Should be done only after #333 is resolved.

TypeScript provides better developer tooling and prevents runtime errors.

Allow usage of Axios

As an alternative to fetch, which is not as well supported in browsers.

Parse '1m16s'-style strings in start-at

YouTube and vimeo allow strings like 1h23m45s as value for their time parameter in video urls (e.g. https://www.youtube.com/watch?v=_FvgGrI6pe4&t=1m5s and https://vimeo.com/283459050#t=2m15s). It would be nice if embetty-vue would also support them as possible value for start-at.

The YouTube iframe needs a single positive integer, though. Parsing could be done like this:

const timeRegex = /^(?:(\d+)h|)(?:(\d+)m|)(?:(\d+)s|)$/;
const timeMatch = query.t.match(timeRegex);

if (timeMatch) {
  // '1m16s'    -> timeMatch = ['1m16s',    undefined, '1', '16']
  // '1h23m45s' -> timeMatch = ['1h23m45s', '1',       '2', '34']
  const [hours, minutes, seconds] = timeMatch.slice(1, 4).map(val => {
    if (val === undefined) {
      return 0;
    }
    return parseInt(val);
  });

  const startAt = (hours * 3600) + (minutes * 60) + seconds;
}