jweiland/video-shariff

This extension provides more privacy when embedding videos in frontend.

Maintainers

Package info

github.com/jweiland-net/video_shariff

Homepage

Type:typo3-cms-extension

pkg:composer/jweiland/video-shariff

Statistics

Installs: 127 415

Dependents: 0

Suggesters: 0

Stars: 5

Open Issues: 1

5.1.2 2026-04-23 12:46 UTC

README

Packagist Latest Stable Version Total Downloads Monthly Downloads TYPO3 14.2

Build Status

This extensions adds a video local hosted preview to videos that has been embedded with fluid_styled_content

1 Features

  • Add preview to videos embedded by fluid_styled_content

2 Usage

2.1 Installation

Installation using Composer

The recommended way to install the extension is using Composer.

Run the following command within your Composer based TYPO3 project:

composer require jweiland/video-shariff

Installation as extension from TYPO3 Extension Repository (TER)

Download and install video_shariff with the extension manager module.

2.2 Minimal setup

  1. Include the static TypoScript of the extension.
  2. Clear Cache.

3 Development

3.1 JavaScript build

The frontend script that swaps the preview image for the real player lives at Resources/Public/JavaScript/VideoShariff.js. The minified bundle that TypoScript loads — Resources/Public/JavaScript/VideoShariff.min.js — is generated from that source with esbuild and committed to the repository so that TER installs and Composer-based projects can use the extension without a Node.js toolchain.

Requirements: Node.js ≥ 20 (see engines in package.json).

Install dev dependencies once:

npm install

Available scripts:

Script What it does
npm run build:js Bundle + minify VideoShariff.js into VideoShariff.min.js (ES2020 target).
npm run watch:js Same as build:js, re-running on every source change.
npm run verify:js Rebuild and fail if the committed VideoShariff.min.js is out of date.

Whenever you edit VideoShariff.js, rebuild and commit the regenerated VideoShariff.min.js in the same commit. CI runs npm run verify:js on every pull request, so a forgotten rebuild will fail the build.

The minified bundle is marked linguist-generated=true in .gitattributes, which collapses it in GitHub's diff UI and excludes it from repository language statistics.

4 Support

Free Support is available via GitHub Issue Tracker.

For commercial support, please contact us at support@jweiland.net.