@ckeditor/ckeditor5-media-embed

What is @ckeditor/ckeditor5-media-embed?

@ckeditor/ckeditor5-media-embed is a plugin for CKEditor 5 that allows users to embed media such as videos and audio from various sources like YouTube, Vimeo, and more. It provides a user-friendly interface for embedding media content directly into the editor.

What are @ckeditor/ckeditor5-media-embed's main functionalities?

Embedding Media

This feature allows users to embed media content from various sources directly into the CKEditor 5 instance. The code sample demonstrates how to initialize CKEditor 5 with the MediaEmbed plugin and add the media embed button to the toolbar.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ MediaEmbed, ... ], toolbar: [ 'mediaEmbed', ... ] })

Custom Media Providers

This feature allows users to define custom media providers for embedding media content. The code sample shows how to configure CKEditor 5 to recognize and embed media from a custom provider.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ MediaEmbed, ... ], mediaEmbed: { providers: [ { name: 'customProvider', url: /customProvider\.com\/media\/([a-zA-Z0-9]+)/, html: match => `<iframe src="https://customProvider.com/media/${match[1]}"></iframe>` } ] } })

Responsive Media Embeds

This feature ensures that embedded media is responsive and adapts to different screen sizes. The code sample demonstrates how to enable responsive media embeds by setting the 'previewsInData' option to true.

ClassicEditor.create(document.querySelector('#editor'), { plugins: [ MediaEmbed, ... ], mediaEmbed: { previewsInData: true } })

Other packages similar to @ckeditor/ckeditor5-media-embed

react-player

react-player is a React component for playing various types of media, including YouTube, Vimeo, SoundCloud, and more. It provides a simple interface for embedding media in React applications. Compared to @ckeditor/ckeditor5-media-embed, react-player is more focused on media playback within React applications rather than being a plugin for a rich text editor.

video.js

video.js is a popular open-source HTML5 video player that supports a wide range of video formats and provides a customizable player interface. While video.js is primarily focused on video playback, it can be integrated into web applications to provide advanced video embedding and playback features. Unlike @ckeditor/ckeditor5-media-embed, video.js is not a text editor plugin but a standalone video player.

plyr

plyr is a simple, customizable HTML5 media player that supports video, audio, and YouTube embeds. It offers a clean and modern interface for media playback. Plyr can be used to embed media content in web applications, but it does not provide the rich text editing capabilities of CKEditor 5. Compared to @ckeditor/ckeditor5-media-embed, plyr is more focused on media playback rather than being an editor plugin.

README

CKEditor 5 media embed feature

This package implements the media embed feature for CKEditor 5. You can use it to insert embeddable media such as YouTube or Vimeo videos and tweets into your rich text content.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

Demo

Check out the demo in the media embed feature guide.

Documentation

See the @ckeditor/ckeditor5-media-embed package page in CKEditor 5 documentation.

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.