Skip to content

代码编辑器

HiCodeEditor 是一个用于在线编写代码的代码编辑器组件,它可以直接运行在浏览器中。支持多种语言的语法高亮,以及不同风格的主题,同时还支持实时语法检查,代码折叠,自定义语法提示等功能。

image

安装方式

bash
yarn add pangea-ui

引用方式

js
import HiCodeEditor from "pangea-ui/hi-code-editor";
import "pangea-ui/dist/style.css";

API

Props

参数名描述类型默认值
model-value (v-model)编辑器数据string、json
mode模式"javascript"、"css"、"json"等javascript
theme主题"eclipse"、"ambiance"、"chrome"、"clouds"等eclipse
fontSize字体大小string14
height高度string300px
minHeight最小高度number300
maxLines最大行数number1000
minLines最小行数number1
autoCompleteList代码提示IAutoCompletion[]
javascript
interface IAutoCompletion {
  caption: string; // 提示-标题
  meta: string; // 提示-内容
  value: string; // 选择提示后插入的内容
  score: number; // 权重。数值越大,提示越靠前
}

Methods

方法名描述参数返回值
getValue获取编辑器值
setValue设置编辑器值value: string、json
focus编辑器获取焦点

Events

事件名描述参数返回值
change编辑器值改变时(string)当前编辑器值
focus编辑器获得焦点时
blur编辑器失去焦点时

使用示例

html
<template>
  <HiCodeEditor v-model="data" :auto-complete-list="autoCompleteList" />
</template>

<script lang="ts" setup>
  import { ref } from "vue";

  // 编辑器值
  const data = ref("");

  // 代码提示
  const autoCompleteList = [
    {
      meta: "获取变量 ctx.state.visible",
      caption: "ctx.state",
      value: "ctx.state",
      score: 3,
    },
  ];
</script>