Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/motla/vue-document-editor
:page_facing_up: Paper-sized WYSIWYG document editor for Vue apps
https://github.com/motla/vue-document-editor
a4 document editor paper vue vuejs wysiwyg
Last synced: about 2 months ago
JSON representation
:page_facing_up: Paper-sized WYSIWYG document editor for Vue apps
- Host: GitHub
- URL: https://github.com/motla/vue-document-editor
- Owner: motla
- License: mit
- Created: 2020-07-15T19:53:37.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-04T14:31:35.000Z (9 months ago)
- Last Synced: 2024-03-14T16:23:49.566Z (6 months ago)
- Topics: a4, document, editor, paper, vue, vuejs, wysiwyg
- Language: Vue
- Homepage: https://motla.github.io/vue-document-editor/
- Size: 18.5 MB
- Stars: 265
- Watchers: 9
- Forks: 60
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
**vue-document-editor** is a rich-text editor built on top of [Vue.js](https://vuejs.org/), using the native [*contenteditable*](https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/Editable_content) browser implementation and some JavaScript trickery to spread content over paper-sized pages. It is mainly designed to allow **targeted modifications** to pre-formatted documents using HTML or **interactive templates**.
###### :speech_balloon: This package does not intend to replace a proper document editor with full functionality. If you're looking for a powerful word processor, check out [CKEditor for Vue.js](https://github.com/ckeditor/ckeditor5-vue) or [Collabora Online Development Edition](https://collaboraonline.github.io/).
## Features
### :rocket: [See live demo](https://motla.github.io/vue-document-editor/)
- Use Vue.js components as interactive page templates
- Word-by-word page splitting (*still experimental - only for plain HTML content*)
- Native Print compatible
- Dynamic document format and margins in millimeters
- Custom page overlays (headers, footers, page numbers)
- Page breaks
- Smart zoom and page display modes
- Computes text style at caret position
- Migrated to Vue.js 3.x (to use with Vue 2.x, select library version 1.x)
###### :speech_balloon: This package doesn't include any toolbar. The demo features [vue-file-toolbar-menu](https://github.com/motla/vue-file-toolbar-menu) for the toolbar.
## Installation
##### In your Vue.js 3.x project:
```
npm install vue-document-editor
```
##### In your Vue.js 2.x project:
```
npm install vue-document-editor@1
```
###### :speech_balloon: If you prefer static files, import assets from the `dist` folder
## Basic example
###### MyComponent.vue
```Vue
import VueDocumentEditor from 'vue-document-editor'
export default {
components: { VueDocumentEditor },
data () {
return {
content: ["<h1>Hello!</h1>Fill this page with text and new pages will be created as it overflows."]
}
}
}
```
same example using static files loaded with a CDN (Vue 3)
```HTML
const app = Vue.createApp({
components: { VueDocumentEditor },
data () {
return {
content: ["<h1>Hello!</h1>Fill this page with text and new pages will be created as it overflows."]
}
}
}).mount('#app');
```
same example using static files loaded with a CDN (Vue 2)
```HTML
var app = new Vue({
el: '#app',
components: { VueDocumentEditor },
data () {
return {
content: ["<h1>Hello!</h1>Fill this page with text and new pages will be created as it overflows."]
}
}
})
```
## Complete example
See the [Demo.vue](src/Demo/Demo.vue) file and the [InvoiceTemplate.ce.vue](src/Demo/InvoiceTemplate.ce.vue) file corresponding to the [live demo](https://motla.github.io/vue-document-editor/).
## API
For the list of props, data and styling variables: **:blue_book: read the [API](API.md)**.
## Known issues / limitations
- **Undo / Redo**: Native undo/redo needs to be rewritten as the split mechanism modifies the HTML content at every input, so the navigator is lost. You have to implement it yourself by watching `content` updates and storing them in a stack, then restoring them. [Demo.vue](src/Demo/Demo.vue) implements this. Also your interactive templates need to have a custom undo/redo management if their editable fields are not synced with the `content`.
- **Performance**: For now, large texts must be divided into multiple paragraphs and large page numbers can slow down the entire document (see [Issue 14](https://github.com/motla/vue-document-editor/issues/14)).
- **Safari print**: Safari adds print margins unless you choose a borderless paper format in the print box. This has to be done manually. I guess there is no workaround for this issue yet.
- **Tables, images**: Image/table placement and sizing is not included. You can implement it specifically for your needs. However, table rows split fine over multiple pages.
- **Page splitting doesn't work with Vue page templates**: This library cannot act on the content managed by Vue (like .vue page templates), because then Vue is lost and the template pages are no longer interactive. The only choice you have is writing plain HTML in the content instead of using .vue templates. You can do interactivity by using HTML elements with the attributes `contenteditable="false"` and `onclick="..."` containing your own JavaScript code.
## Project development
- `npm run serve` compiles, serves and hot-reloads demo for development
- `npm run build` compiles and minifies production files and demo
## Licensing
Copyright (c) 2020 Romain Lamothe, [MIT License](LICENSE)