Drupal
/
drupal
mirror of https://git.drupalcode.org/project/drupal.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #3317332 by Wim Leers: Remove obsolete core/modules/ckeditor5/js/ckeditor5_plugins/drupalMedia/README.md 

(cherry picked from commit 35f35949ad)
merge-requests/2710/merge
catch 2022-10-26 09:07:11 +01:00
parent ecb9ad9c46
commit 46b2ae3f21
1 changed files with 0 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
core/modules/ckeditor5/js/ckeditor5_plugins/drupalMedia/README.md
View File

@ -1,39 +0,0 @@
# ckeditor5-drupal-media
Drupal media plugin for CKEditor5
Provides required attributes `data-entity-uuid` and `data-entity-type`.
## Usage
This project is for creating minified js for [Drupal CKEditor5](http://drupal.org/project/ckeditor5)
When using this plugin, you must provide the following config in `drupalMedia`:
1. `libraryURL`: The URL at route media_library.ui to open a browse dialog
2. `previewURL`: The URL at route media.filter.preview to render a media preview
3. `openDialog`: The function to open a Drupal dialog
4. `themeError`: The markup to display if the preview fails
Example config:
```
ClassicEditor
.create(editorElement, {
drupalMedia: {
libraryURL: '/media-library?...',
previewURL: '/media/{filter_format}/preview',
openDialog: Drupal.ckeditor5.openDialog,
themeError: Drupal.theme('mediaEmbedPreviewError'),
},
});
.then( ... )
.catch( ... );
```
## Build
Run `npm run dll:build` to create the minified js.
Check the file path in `webpack.config.js` to ensure it points to the dll
manifest in your copy of `ckeditor5`.