npmpackage.info

Gathering detailed insights and metrics for vue-prism-editor

Other packages similar to vue-prism-editor

@amino-editor/vue-prism

1.0.0

Easily integrate Prsim.js code highlighting into Vue.js

@ennis/vue-editor

0.0.3

vue-prism-editor fork with multiline tab support

@dans98/vue-prism-editor

0.5.2

A dead simple code editor with syntax highlighting and line numbers.

@coscom/vue-prism-editor

0.1.1

A simple code editor with syntax highlighting and line numbers.

Gathering detailed insights and metrics for vue-prism-editor

vue-prism-editor - 1.3.0 | npmpackage.info

vue-prism-editor

A dead simple code editor with syntax highlighting and line numbers. 3kb/gz

1.3.0

761

MIT

TypeScript

2.4

Installations

npm install vue-prism-editor

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10

Node Version

16.8.0

NPM Version

7.21.0 Pull Requests

Open

5

Total

47

Closed

21

Merged

21

Issues

Open

20

Total

100

Closed

80

Releases

vue-prism-editor@1.3.0

Updated on Sep 27, 2021

v2.0.0-alpha.1

2.0.0-alpha.1

Updated on Oct 16, 2020

v2.0.0-alpha.2

2.0.0-alpha.2

Updated on Oct 21, 2020

v1.2.0

Updated on Aug 09, 2020

v1.1.0

Updated on Aug 09, 2020

v1.0.1

Updated on Aug 08, 2020

View All 19 releases

Languages

TypeScript

JavaScript

CSS

Vue

HTML

TypeScript (77.74%)

JavaScript (8.11%)

CSS (6.79%)

Vue (5.86%)

HTML (1.5%)

Developer

koca

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

761 Stars

103 Commits

83 Forks

7 Watchers

2 Branches

8 Contributors

Updated on Jul 10, 2025

Maintainers

View All 8 Contributors

Package Meta Information

Latest Version

1.3.0

Package Id

vue-prism-editor@1.3.0

Size

58.05 kB

NPM Version

7.21.0

Node Version

16.8.0

Published on

Sep 27, 2021

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

Peer Dependencies

vue

Dev Dependencies

@testing-library/jest-dom @testing-library/vue @types/prismjs @vue/cli-plugin-unit-jest jest-environment-jsdom-sixteen prismjs rollup-plugin-postcss tsdx tslib typescript vue-jest

Vue Prism Editor

Codecov

A dead simple code editor with syntax highlighting and line numbers. 3kb/z

prism-editor

Editor works both for Vue 2.x and Vue 3.x and you are currently on the branch that supports Vue 2.x. Go here for the Vue 3.x compatible version

Demo

prism-editor.netlify.com

Examples

Vue Example Codesandbox: https://codesandbox.io/s/61yrlnlnmn
Nuxt Example Codesandbox: https://codesandbox.io/s/nuxt-vue-prism-editor-62e06
Vite Example Codesandbox: https://codesandbox.io/s/vite-vue-prism-editor-q9j8p
Codepen: https://codepen.io/koca/pen/QVgqyR

Features

Code Editing
Modular syntax highlighting with third party library (not limited to prismjs)
Indent line or selected text by pressing tab key, with customizable indentation
Automatic indent on new lines
Wrap selected text in parens, brackets, or quotes
Undo / Redo whole words instead of letter by letter
Accessible, use Ctrl+Shift+M (Mac) / Ctrl+M to toggle capturing tab key
Works on mobile (thanks to textarea)
Auto resize
Line numbers
Match line numbers styles to the theme(optional)

Use Case

Several browser based code editors such as Ace, CodeMirror, Monaco etc. provide the ability to embed a full-featured code editor in your web page. However, if you just need a simple editor with syntax highlighting without any of the extra features, they can be overkill as they don't usually have a small bundle size footprint. This library aims to provide a simple code editor with syntax highlighting support without any of the extra features, perfect for simple embeds and forms where users can submit code.

Install

1npm install vue-prism-editor

1yarn add vue-prism-editor

Usage

You need to use the editor with a third party library which provides syntax highlighting. For example, it'll look like following with prismjs:

1<template>
2  <prism-editor class="my-editor" v-model="code" :highlight="highlighter" line-numbers></prism-editor>
3</template>
4
5<script>
6  // import Prism Editor
7  import { PrismEditor } from 'vue-prism-editor';
8  import 'vue-prism-editor/dist/prismeditor.min.css'; // import the styles somewhere
9
10  // import highlighting library (you can use any library you want just return html string)
11  import { highlight, languages } from 'prismjs/components/prism-core';
12  import 'prismjs/components/prism-clike';
13  import 'prismjs/components/prism-javascript';
14  import 'prismjs/themes/prism-tomorrow.css'; // import syntax highlighting styles
15
16  export default {
17    components: {
18      PrismEditor,
19    },
20    data: () => ({ code: 'console.log("Hello World")' }),
21    methods: {
22      highlighter(code) {
23        return highlight(code, languages.js); // languages.<insert language> to return html with markup
24      },
25    },
26  };
27</script>
28
29<style>
30  /* required class */
31  .my-editor {
32    /* we dont use `language-` classes anymore so thats why we need to add background and text color manually */
33    background: #2d2d2d;
34    color: #ccc;
35
36    /* you must provide font-family font-size line-height. Example: */
37    font-family: Fira code, Fira Mono, Consolas, Menlo, Courier, monospace;
38    font-size: 14px;
39    line-height: 1.5;
40    padding: 5px;
41  }
42
43  /* optional class for removing the outline */
44  .prism-editor__textarea:focus {
45    outline: none;
46  }
47</style>

Note that depending on your syntax highlighter, you might have to include additional CSS for syntax highlighting to work.

Or register the component globally

1import { PrismEditor } from 'vue-prism-editor';
2import 'vue-prism-editor/dist/prismeditor.min.css'; // import the styles
3Vue.component('PrismEditor', PrismEditor);

Browser usage (for codepen etc.):

1<script src="https://unpkg.com/vue@2.6.*"></script>
2
3<!-- Prism Editor -->
4<script src="https://unpkg.com/vue-prism-editor"></script>
5<link rel="stylesheet" href="https://unpkg.com/vue-prism-editor/dist/prismeditor.min.css" />
6
7<!-- custom highlighter: -->
8<script src="https://unpkg.com/prismjs/prism.js"></script>
9<link rel="stylesheet" href="https://unpkg.com/prismjs/themes/prism-tomorrow.css" />
10
11<style>
12  .height-200{
13    height: 200px  
14  }
15  
16  .my-editor {
17    /* we dont use `language-` classes anymore so thats why we need to add background and text color manually */
18    background: #2d2d2d;
19    color: #ccc;
20
21    /* you must provide font-family font-size line-height. Example:*/
22    font-family: Fira code, Fira Mono, Consolas, Menlo, Courier, monospace;
23    font-size: 14px;
24    line-height: 1.5;
25    padding: 5px;
26  }
27
28  /* optional class for removing the outline */
29  .prism-editor__textarea:focus {
30    outline: none;
31  }
32</style>
33
34<div id="app">
35  <prism-editor class="my-editor height-200" v-model="code" :highlight="highlighter" line-numbers></prism-editor>
36</div>
37
38<script>
39  new Vue({
40    el: "#app",
41    data: () => ({
42      code: "console.log('hello world')"
43    }),
44    methods: {
45      highlighter(code) {
46        // js highlight example
47        return Prism.highlight(code, Prism.languages.js, "js");
48      }
49    },
50  })
51</script>

Props

Name	Type	Default	Options	Description
v-model `value`	`string`	`""`	-	Current value of the editor i.e. the code to display
highlight	`string => string`	-	-	Callback which will receive text to highlight. You'll need to return an HTML string with syntax highlighting using a library such as prismjs.
readonly	`Boolean`	`false`	-	Readonly
lineNumbers	`Boolean`	`false`	-	Whether to show line numbers. Default `false`
autoStyleLineNumbers	`Boolean`	`true`	-	Match line numbers text color to the theme. Default `true`
tabSize	`number`	`2`	-	The number of characters to insert when pressing tab key. For example, for 4 space indentation, `tabSize` will be `4` and `insertSpaces` will be `true`. Default: `2`
insertSpaces	`boolean`	`true`	-	Whether to use spaces for indentation. Default: `true`. If you set it to `false`, you might also want to set `tabSize` to `1`
ignoreTabKey	`boolean`	`false`	-	Whether the editor should ignore tab key presses so that keyboard users can tab past the editor. Users can toggle this behaviour using `Ctrl+Shift+M` (Mac) / `Ctrl+M` manually when this is `false`. Default: `false`

Events

Name	Parameters	Description
input	`(code)`	Fires when the code is changed.
keydown	`(event)`	This event is emitted when a keydown event happens in editor
keyup	`(event)`	This event is emitted when a keyup event happens in editor
click	`(event)`	This event is emitted when clicking anywhere in the editor
focus	`(event)`	This event is emitted when focus
blur	`(event)`	This event is emitted when blur

How it works

This part is taken from react-simple-code-editor

It works by overlaying a syntax highlighted <pre> block over a <textarea>. When you type, select, copy text etc., you interact with the underlying <textarea>, so the experience feels native. This is a very simple approach compared to other editors which re-implement the behaviour.

The syntax highlighting can be done by any third party library as long as it returns HTML and is fully controllable by the user.

The vanilla <textarea> doesn't support inserting tab characters for indentation, so we re-implement it by listening to keydown events and programmatically updating the text. One caveat with programmatically updating the text is that we lose the undo stack, so we need to maintain our own undo stack. As a result, we can also implement improved undo behaviour such as undoing whole words similar to editors like VSCode.

Limitations

Due to the way it works, it has certain limitations:

The syntax highlighted code cannot have different font family, font weight, font style, line height etc. for its content. Since the editor works by aligning the highlighted code over a <textarea>, changing anything that affects the layout can misalign it.
The custom undo stack is incompatible with undo/redo items browser's context menu. However, other full featured editors don't support browser's undo/redo menu items either.
The editor is not optimized for performance and large documents can affect the typing speed.
We hide text in the textarea using -webkit-text-fill-color: transparent, which works in all modern browsers (even non-webkit ones such as Firefox and Edge). On IE 10+, we use color: transparent which doesn't hide the cursor. Text may appear bolder in unsupported browsers.

Thanks

react-simple-code-editor

License

MIT

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.

5

Code-Review

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

0

CII-Best-Practices

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

0

Maintained

Determines if the project is "actively maintained".

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

141 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-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
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-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
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-ff7x-qrg7-qggm
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
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-vfrc-7r7c-w9mx
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-rc47-6667-2j5j
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-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
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-79jw-6wg7-r9g4
Warn: Project is vulnerable to: GHSA-r5cq-9537-9rpf
Warn: Project is vulnerable to: GHSA-84p7-fh9c-6g8h
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
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-3j8f-xvm3-ffx4
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
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-wvhm-4hhf-97x9
Warn: Project is vulnerable to: GHSA-h4hr-7fg3-h35w
Warn: Project is vulnerable to: GHSA-gj77-59wh-66hg
Warn: Project is vulnerable to: GHSA-hqhp-5p83-hx96
Warn: Project is vulnerable to: GHSA-3949-f494-cm99
Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
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-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-29xr-v42j-r956
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
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-g78m-2chm-r7qv
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

2.4

/10

Last Scanned on 2025-07-07

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