Skip to content

wjpeters/vue2-ace-code-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

vue2-ace-editor

A Vue2 component for including the ace editor.

Installation

npm install -save vue2-ace-code-editor

How to use

Import the component, the mode and the theme in <script>.

import editor from 'vue2-ace-code-editor'
import 'brace/mode/javascript'
import 'brace/theme/chrome'

Register the component in the Vue options.

components: {
  editor
}

Use the component in your template. Make sure to change variable to a string the editor should start with (it can be an empty string too).

<editor :content="variable" v-on:change-content="changeContent"></editor>

The content-prop is required, the other props have the following defaults:

lang: javascript
theme: chrome
height: 300px
width: 100%
sync: false

If you want to change any of these defaults, just include them when you use the component in the template.

<editor :content="variable" :height="'500px'"></editor>

<editor :content="variable" :width="'50%'"></editor>

<editor :content="variable" :lang="'html'"></editor>

<editor :content="variable" :theme="'github'"></editor>

<editor :content="variable" :sync="true"></editor>

The theme can be changed after the component already has been mounted. Just change the string of the theme-variable.

To sync the content of the editor to the original content-variable, set the sync prop to true. Watch out: Every time the the original variable updates, the editor will also update it's content.

If you want to use another lang or theme, don't forget to import it.

Last but not least listen on the editor-update. Make sure to replace vm.function with the function you want to execute.

mounted () {
  const vm = this;
  vm.$on('change-content', vm.function);
}

About

A Vue2 component for including the ace editor.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published