Skip to content

Commit

Permalink
Init project
Browse files Browse the repository at this point in the history
  • Loading branch information
shibbirweb committed Nov 2, 2020
0 parents commit fa68bcc
Show file tree
Hide file tree
Showing 7 changed files with 403 additions and 0 deletions.
107 changes: 107 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
#IDE
/.idea

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# Next.js build output
.next

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 MD. Shibbir Ahmed

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# CKEditor 5 Image Remove Event Callback Plugin

Handle image remove event callback from CKEditor 5

### Usage:

Install package

```
npm install ckeditor5-image-remove-event-callback-plugin
```


Use in Build

```js
// app.js
// ...
import ImageRemoveEventCallbackPlugin from 'ckeditor5-image-remove-event-callback-plugin'; // Add this
// ...

ClassicEditor.builtinPlugins = [
// ...
ImageRemoveEventCallbackPlugin
// ...

]
```
Use in CKEditor 5 initialization
```js
ClassicEditor.create(document.querySelector('#editor'), {
//...
imageRemoveEvent: {
callback: (imageSrc, nodeObject) => {
//nodeObject api: https://ckeditor.com/docs/ckeditor5/latest/api/module_engine_model_node-Node.html
// ... do your staff
console.log('callback invoked', imageSrc, nodeObject)

}
},
// ...
});
```

108 changes: 108 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 29 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "ckeditor5-image-remove-event-callback-plugin",
"version": "1.0.0",
"description": "CKEditor 5 image remove event handler plugin",
"dependencies": {
"@ckeditor/ckeditor5-core": "*",
"@ckeditor/ckeditor5-image": "*"
},
"main": "src/ImageRemoveEventCallbackPlugin.js",
"repository": {
"type": "git",
"url": "https://github.com/shibbirweb/ckeditor5-image-remove-event-callback-plugin.git"
},
"files": [
"src"
],
"keywords": [
"CKEditor 5",
"image",
"image remove event"
],
"author": "MD. Shibbir Ahmed <shibbirweb@gmail.com> (http://shibbir.me/)",
"license": "MIT",
"bugs": {
"url": "https://github.com/shibbirweb/ckeditor5-image-remove-event-callback-plugin/issues",
"email": "shibbirweb@gmail.com"
},
"homepage": "https://github.com/shibbirweb/ckeditor5-image-remove-event-callback-plugin#readme"
}
56 changes: 56 additions & 0 deletions src/ImageRemoveEvent.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/**
* @author MD. Shibbir Ahmed <shibbirweb@gmail.com> (http://shibbir.me/)
*
*/
export default class ImageRemoveEvent {

constructor(editor, configuration) {
this.editor = editor
this.configuration = configuration

this.emitCallback()
}

emitCallback() {
const { callback } = this.configuration
const editor = this.editor
let model = editor.model

model.document.on('change:data', () => {
const differ = model.document.differ

// if no difference
if (differ.isEmpty) {
return;
}

const changes = differ.getChanges({
includeChangesInGraveyard: true
});

if (!changes || !changes[1]) {
return;
}

const lastChange = changes[1]

if (lastChange && (lastChange.name && lastChange.name === 'image') && (lastChange.type && lastChange.type === 'remove')) {
// The graveyard tree root
const previousImageGraveyard = changes[0]

if (!previousImageGraveyard) {
return;
}

// Root Element
const root = previousImageGraveyard.position.root
// Removed node
const removedImageNode = root.getChild(0)
// Removed image src
const removedImageSrc = removedImageNode.getAttribute('src')
// Call the callback
return callback(removedImageSrc, removedImageNode)
}
})
}
}
Loading

0 comments on commit fa68bcc

Please sign in to comment.