@ckeditor/ckeditor5-media-embed
Advanced tools
@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.
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 } })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 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 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.
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.
Check out the demo in the media embed feature guide.
See the @ckeditor/ckeditor5-media-embed package page in CKEditor 5 documentation.
npm install ckeditor5
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.
43.3.0 (October 29, 2024)
We are happy to announce the release of CKEditor 5 v43.3.0.
We have improved how the editor handles the document structure by making it more reliable and efficient to access specific elements and verify their positions.
Node and NodeList elements now cache index and offset values, reducing the need for recalculations and significantly boosting overall performance during model operations.Position#isValid() method is also utilized to better validate selection ranges, ensuring more consistent behavior in various editing scenarios.We’re committed to ongoing performance enhancements, so you can expect even faster, smoother experience in future updates.
A new configuration option has been added to include a watermark when exporting documents to Word, providing additional flexibility in document branding and protection.
getChildAtOffset() method for model.Element and model.DocumentFragment. (commit)Position#isValid() method to check whether the position exists in the current model tree. (commit)RevisionTracker#getRevisionDocumentData() and RevisionTracker#getRevisionRootsAttributes() methods to the public scope of the editor API. You can use them to retrieve document data saved with the revision.FocusTracker extendable with other FocusTracker instances to allow logical focus tracking across separate DOM sub-trees (see #17277). (commit)sources downcast. (commit)LinkConfig#addTargetToExternalLinks: true is set. Closes https://github.com/ckeditor/ckeditor5/issues/17252. (commit)BalloonToolbar while the user hovers a nested menu. Closes #17277. (commit)Node and NodeList to improve performance. (commit)ckeditor5-link package. Closes #17304. (commit)Dialog plugin. Closes #17290. (commit)config.ui.viewportOffset. Closes #17290. (commit)Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Releases containing new features:
Other releases:
To see all releases, visit the release page.
FAQs
Media embed feature for CKEditor 5.
The npm package @ckeditor/ckeditor5-media-embed receives a total of 339,128 weekly downloads. As such, @ckeditor/ckeditor5-media-embed popularity was classified as popular.
We found that @ckeditor/ckeditor5-media-embed demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.