README

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:

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.