Simple CodeEditor for Vue.js

Vue.js version: 3.0

website: simple-code-editor.vicuxd.com

It's easy to use, both support read-only and edit mode, you can directly use it in the browser or import the JavaScript modules via the NPM package

View Demo View Github

Useage

In the Browser

Step 1. Add the CSS file.

<link rel="stylesheet" href="/path/code_editor.min.css">

Step 2. Add the JavaScript files after the vue.js file.

<script src="/path/highlight.min.js"></script>
<script src="/path/code_editor.prod.js"></script>

Step 3. Declaring the component, and using the customized tag into the HTML template. For all configure items please check the API list.

const app = Vue.createApp({
  components: {
      'code-editor': CodeEditor
  }
})

<code-editor></code-editor>

Install with NPM

Step 1

npm install simple-code-editor

Step 2. Importing the component and registration.

import CodeEditor from 'simple-code-editor';
export default {
    components: {
      CodeEditor
    }
}

<CodeEditor></CodeEditor>

Customizing the theme style

You can cover the CSS file to customize the theme style.

<link rel="stylesheet" href="/path/theme.css">

API

read_only Boolean

Default: false

Description: whether the code is editable

<CodeEditor :read_only="true"></CodeEditor>

value String

Default: unset

Description: setting the contents of a code editor. If you want to bind the data, please use the property v-model

<CodeEditor value="console.log(13)"></CodeEditor>

v-model

Description: varies based on the value of form inputs element or output of components, the specific usage you can read Vue.js Documentation

language_selector Boolean

Default: false

Description: whether the language selector is availed, if the value is true, you can use the property languages to set which languages can be selected

<CodeEditor :language_selector="true"></CodeEditor>

languages Array

Default: [["javascript", "JS"],["cpp", "C++"],["python", "Python"]]

Description: when the value of language_selector is true, you can set the language list to be selected. This property is a two-dimensional array, the first item of each child is an index of the language and it's required, the second item of each child is used for display, which is for the better user reading experience, it can be free to customize and optional, if it's unset the UI display will be replaced with the index of the language

<CodeEditor :language_selector="true" :languages="[['javascript', 'JS'],['python', 'Python']]"></CodeEditor>

wrap_code Boolean

Default: false

Description: whether the code is allowed to wrap automatically

<CodeEditor :wrap_code="true"></CodeEditor>

hide_header Boolean

Default: false

Description: whether the header of code editor is hidden

<CodeEditor :hide_header="true"></CodeEditor>

display_language Boolean

Default: true

Description: whether the language name is displayed

<CodeEditor :display_language="false"></CodeEditor>

copy_code Boolean

Default: true

Description: whether the code can be copied by the icon button

<CodeEditor :copy_code="true"></CodeEditor>

font_size String

Default: 17px

Description: setting the font size

<CodeEditor font_size="17px"></CodeEditor>

width String

Default: 540px

Description: setting the width of the code editor

<CodeEditor width="540px"></CodeEditor>

height String

Default: auto

Description: the height of the container is adaptive by default, you can also set it to a specific value, and the scroll bar will work with a long text

<CodeEditor height="150px"></CodeEditor>

min_width String

Default: unset

Description: setting the min-width of the code editor

<CodeEditor min_width="200px"></CodeEditor>

min_height String

Default: unset

Description: setting the min-height of the code editor

<CodeEditor min_height="200px"></CodeEditor>

max_width String

Default: unset

Description: setting the max-width of the code editor

<CodeEditor max_width="200px"></CodeEditor>

max_height String

Default: unset

Description: setting the max-height of the code editor

<CodeEditor max_height="200px"></CodeEditor>

border_radius String

Default: 12px

Description: setting the radius of the code editor

<CodeEditor border_radius="4px"></CodeEditor>

selector_width String

Default: 110px

Description: setting the width of the selector

<CodeEditor selector_width="150px"></CodeEditor>

selector_height String

Default: auto

Description: setting the height of the selector

<CodeEditor selector_height ="90px"></CodeEditor>

selector_displayed_by_default Boolean

Default: false

Description: whether the selector is displayed by default

<CodeEditor :selector_displayed_by_default="true"></CodeEditor>

z_index String

Default: unset

Description: setting the stack order of the code editor

<CodeEditor z_index="6"></CodeEditor>