npmpackage.info

Gathering detailed insights and metrics for @dymantic/vue-trix-editor

Other packages similar to @dymantic/vue-trix-editor

@dymantic/trix-vue-wysiwyg

0.1.0

Wysiwyg editor as vue component using Basecamps's Trix editor

Gathering detailed insights and metrics for @dymantic/vue-trix-editor

@dymantic/vue-trix-editor - 0.5.0 | npmpackage.info

@dymantic/vue-trix-editor

A rich text editor as a Vue component, with image and auto-save support

0.5.0

MIT

Vue

2.60 MB

1.7

Installations

npm install @dymantic/vue-trix-editor

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

13.7.0

NPM Version

6.13.6 Pull Requests

Open

1

Total

4

Closed

0

Merged

3

Issues

Open

0

Total

5

Closed

5

Releases

Unable to fetch releases

Languages

Vue

JavaScript

HTML

Vue (58.45%)

JavaScript (40.44%)

HTML (1.11%)

Developer

Dymantic

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

37 Stars

72 Commits

6 Forks

2 Watchers

2 Branches

4 Contributors

Updated on Feb 24, 2025

Maintainers

View All 4 Contributors

Package Meta Information

Latest Version

0.5.0

Package Id

@dymantic/vue-trix-editor@0.5.0

Unpacked Size

2.60 MB

Size

663.57 kB

File Count

NPM Version

6.13.6

Node Version

13.7.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

axios trix vue

Dev Dependencies

@vue/cli-plugin-babel @vue/cli-plugin-eslint @vue/cli-plugin-unit-jest @vue/cli-service @vue/test-utils babel-core babel-jest moxios sinon vue-template-compiler

Vue Trix Rich Text Editor

A Vue wrapper around the Trix rich-text editor, with support for images and auto-save.

Note: No true two-one binding.

While you can use v-model to bind the editor contents (the formatted HTML) to your own Vue instance or component,you won't get true two-way binding with this component. That means that if you update the value of your content outside of the editor, it will not be taken into account by the editor. This means you have to treat the editor as the source of truth, not whatever you bind it to. The reason for this is that Trix only reads in the initial content once on initialization, so to force two-way binding, we would have to make Trix re-evaluate and rebuild the entire document on every keystroke, which is not really worth it.

Installation

npm install @dymantic/vue-trix-editor

Usage Example

1// simple rich-text editor, the html output is bound to whatever my_html is
2// the editor will initailly be populated with the contents from my_html
3<trix-vue v-model="my_html"></trix-vue>
4
5// same as above, but will allow adding images
6<trix-vue v-model="my_html" image-upload-path="/url/to/upload/images"></trix-vue>
7
8// simple rich-text editor, with a "save" button. Will send editor contents as POST to save-path
9<trix-vue v-model="my_html" save-path="/url/to/save/contents"></trix-vue>
10
11// same as above, but will auto-save at given interval (in seconds) if changes have been made
12<trix-vue v-model="my_html" save-path="/url/to/save/contents" :save-interval="10"></trix-vue>
13
14// all together now, and allow up to 20MB images
15<trix-vue v-model="my_html"
16          image-upload-path="/url/to/upload/images"
17          max-image-file-size="20"
18          save-path="/url/to/save/contents"
19          :save-interval="10"
20></trix-vue>

Uploading images

If you use the upload images, by supplying the endpoint where your server accepts the image to the image-upload-path prop, you need to implement the server side parts yourself. Then ensure that the server reponds with the a body that includes {src: [URL FOR YOUR STORED IMAGE]}. If this is not present in the response, the image will not be inserted.

By deafult, a max file size of 5MB is allowed for images, but this may be set via the max-image-file-size prop.

Adding alt attributes for your images

The regular workflow for adding images does not allow for adding alt attributes for your images. However, if you use the insert-images-with-dialog prop (set to true), you may upload your image and include the alt text. The insert image button will now bring up a modal dialog for you to add your image and the alt text, as well as the caption. The disadvantage to this is that the image needs to completely upload before you can insert it into the document, which is not the case with the regular image workflow.

Props

The following props can be used to define the components behaviour

Prop name	required	default	Notes
initial-content	false	""	The content to populate the editor with initially (or use v-model)
image-upload-path	false	""	Supplying a value here allows for image uploads
max-image-file-size	false	5	Specify the maximum image filesize in MB
save-path	false	""	Supplying a url will allow content to be saved
save-as	false	"content"	If using save feature, the name of the form field will be this
save-interval	false	null	Time in seconds to auto-save. Only saves if there are changes since last save
placeholder	false	''	The placeholder to be used for the empty state of the editor
sticky	false	`false`	Sticky position the toolbar to remain on the screen while editing.
insert-images-with-dialog	false	`false`	If true, you may use a modal dialog to upload images with alt text
axios-config	false	`{}`	Config object to be passed to axios when posting content or uploading images
multi-headings	false	false	Allow multiple heading lavels in toolbar (adds h2, h3 and h4)

Events

The editor will fire the following events:

Event name	payload	Notes
image-rejected	(file, message)	Fired if a user's image cannot be attached, either due to network error or invalid file
image-attached	null	Fired after an image has been successfully uploaded and inserted into document
content-changed	null	Fired whenever editor content changes.
content-saved	null	Fired after editor contents have been successfully saved (200-ish response from server)
content-save-failed	null	Fired an error occurs while saving content to provided endpoint

Extending functionality through scoped slot

Requires Vue 2.6 or higher

This component provides a default scoped slot, which will render whatever you put in it in the top toolbar. The intention is to allow for your own buttons, etc to be added that allows you to insert content into the editor. An example would be to add embeds (Youtube, iframes, etc) as attachments.

By adding the v-slot directive to the component you may get access to the document slot-prop, which is an object with two methods on it you may call. The methods are attachment and html, which will insert whatever content you provide as either an attachment or as html, respectively.

Note: Html that Trix does not understand how to format will be ignored. You would be better off using an attachment for those situations.

The example below should provide some guidance:

1//in your own component or page
2<trix-vue v-model="my_html"
3          image-upload-path="/url/to/upload/images"
4          max-image-file-size="20"
5          save-path="/url/to/save/contents"
6          :save-interval="10"
7          v-slot="{document}"
8>
9    <embed-youtube-button :trix="document"></embed-youtube-button>
10</trix-vue>
11
12//in your embed-youtube-button component
13<template>
14 // ....
15</template>
16
17<script>
18    props: ['trix'],
19
20    data() {
21        return {
22            attachment_content: '', //will probably be the v-model for a textarea
23        };
24    },
25
26    methods: {
27        // an example method that you would call to insert the attachmnet once the attachment_content has been entered
28        addAttachment(content) {
29            this.trix.attachment(this.attachment_content);
30        }
31    }
32</script>
33

Pesky console warning for unkown element 'trix-editor'

In development mode, you will get a warning about an unknown element <trix-editor>. This is because Trix uses custom elements, and vue assumes they should be vue components. These can't be ignored, because we do need to Vue to render the cusom elements.

While the warning is harmless, it can be suppressed with the following code.

//somewhere in your code where you have access to the Vue instance
Vue.config.ignoredElements = [
    'trix-editor',
];

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

110 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx
Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-257v-vj4p-3w2h
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-7r28-3m3f-r2pr
Warn: Project is vulnerable to: GHSA-r8j5-h5cx-65gg
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-7wpw-2hjm-89gp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-qjqp-xr96-cj99
Warn: Project is vulnerable to: GHSA-qm2q-9f3q-2vcv
Warn: Project is vulnerable to: GHSA-j386-3444-qgwg
Warn: Project is vulnerable to: GHSA-mcrw-746g-9q8h
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-5j4c-8p2g-v4jx
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More