Skip to main content

Code Editor

WdCodeEditor

Applicable Scenarios​

A code editor wrapped based on React CodeMirror. A form component used to assist with code input and display.

Basic Capabilities Description​

  1. Bind a Rich Text type field. Input value, placeholder text, and component size can be configured.

  2. Supports language configuration. Currently, only JS, TypeScript, MongoDB, SQL, and MySQL are supported.

  3. Supports switching between light and dark themes.

  4. Supports personalized configuration of titles, including title content, alignment, line break behavior (when enabled, titles exceeding one line wrap; when disabled, titles exceeding one line truncate with ellipsis), title position, width, and title tooltip.

To learn more about usage scenarios for form components, refer to the Form Common Scenarios Practice Guide.

Example​

Interactive Preview​

Component Decoration​

Component Size​

Component Alignment​

Component Input State​

Component Style API Example​

#wd-page-root .wd-form-item .wd-code-editor {
  border-color: cyan;
  color: cyan;
  border-width: 2px;
  border-radius: 6px;
  --wd-color-text-placeholder: red;
}

Properties​

External properties received by the component

Property Name
Property Identifier
Type
Description
显示标题labelVisibleboolean

Default value: true

标题对齐labelAlignstring

表单场景下默认会跟随表单容器的标题对齐配置

标题换行labelWrapboolean

如果标题内容过长关闭时只显示一行、溢出省略；开启时换行展示。表单场景下默认会跟随表单容器的标题换行配置

标题位置layoutstring

设置标题在表单组件的展示位置，表单场景下默认会跟随表单容器的标题的位置配置

标题宽度labelWidthstring

您可以输入数值 + px、%等单位，示例：200px

表单场景下默认会跟随表单容器的标题宽度配置

标题提示labelTipsstring

PC/H5端生效

配置标题的工具提示内容

下方提示extrastring

配置后提示内容常显在输入框下方

自动获取焦点focusboolean

开启后页面加载后光标自动定位到该输入框

移动端显示下划线borderedH5boolean

关闭后移动端不显示底部下划线

Default value: true

校验规则rulesarray

Default value: []

状态statusstring

Example: "edit"

必填requiredboolean
必填标识requiredFlagboolean

启用后，组件若要求必填，则会显示必填星号标记

Default value: true

必填校验提示requiredMsgstring

Example: "该项为必填项"

绑定字段namestring

表单字段的Key值，用于提交数据时，匹配数据模型字段标识。表单内需保证唯一。

Example: "formCodeEditor"

标题内容labelstring

Example: "标题"

支持语言languagestring

Example: "javascript"

主题themestring

Example: "githubLight"

输入值valuestring

Example: ""

占位文字placeholderstring

Example: "请输入"

PC端组件尺寸sizestring

尺寸配置仅对PC端生效，表单场景下默认会跟随表单容器的组件尺寸配置

Events​

Events exposed by the component. You can listen to component events to trigger external actions

Event Name
Event Code
Event Output Parameters event.detail
Applicable Scenarios
Description
值改变changeobject
  • value: string

    输入值
Compatible with all platforms

用户修改组件值时触发

代码编辑器readyreadyCompatible with all platforms

当前代码编辑器已完成实例初始化

Property API​

Through the Property API, you can access the internal state and property values of components. You can access internal values using$w.componentId.propertyName, such as $w.input1.value. For details, please refer to Property API

Read-only Property Name
Property Identifier
Type
Description
绑定字段namestring

表单字段的Key值，用于提交数据时，匹配数据模型字段标识。表单内需保证唯一。

标题内容labelstring
输入值valuestring
必填requiredboolean
是否展示visibleboolean

组件是否展示

是否禁用disabledboolean

组件是否禁用

是否只读readOnlyboolean

组件是否只读

Method API​

Through the Method API, you can programmatically trigger internal methods of components, such as submitting forms, displaying popups, etc. You can call component methods using $w.componentId.methodName, such as $w.form1.submit()

Method Name
Method Identifier
Parameters
Method Description
设置值setValuestring值

通过 $w.id1.setValue("weda") 设置组件值

设置显隐setVisibleboolean显示

通过 $w.id1.setVisible(false) 设置组件为隐藏

设置禁用setDisabledboolean禁用

通过 $w.id1.setDisabled(true) 设置组件为禁用

清空值clearValue

通过 $w.id1.clearValue() 清空组件值

设置只读setReadOnlyboolean只读

通过 $w.id1.setReadOnly(true) 设置组件为只读

触发校验handleValidate

通过 $w.id1.handleValidate() 校验组件值

清除校验clearValidate

通过 $w.id1.clearValidate() 清除组件校验

js格式化formatobject
  • isCustomVal: boolean自定义入参

    是否使用传入的格式化内容进行格式化。默认格式化当前组件值，开启则使用传入的格式化内容进行格式化，方法执行后返回格式化结果。
  • value: string格式化内容

目前仅支持js格式化组件值

Style API​

Through the Style API, you can override the styles of internal elements in components to achieve customization. For example, in the low-code editor, you can write styles for all button components using #wd-page-root .wd-btn, and control individual component styles with :scope. For detailed instructions, please refer toStyle API

Name
Class Name
Description and Examples
根元素.wd-codeEditor-root组件最外层元素
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-codeEditor-root {
  /* Write CSS styles here */
}
H5 端根元素.wd-h5-codeEditor-root可设定 H5 端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-h5-codeEditor-root {
  /* Write CSS styles here */
}
PC 端根元素.wd-pc-codeEditor-root可设定 PC 端的根元素样式
/* :scope refers to the current component element */
/* For details, refer to the Style API documentation */
:scope.wd-pc-codeEditor-root {
  /* Write CSS styles here */
}
组件标题样式.wd-codeEditor-root .wd-form-item-wrap__label组件标题元素

:scope .wd-form-item-wrap__label {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
表单控件根节点样式.wd-codeEditor-root .wd-form-item-wrap__control设置表单控件根元素样式

:scope .wd-form-item-wrap__control {
  font-size: 20px;
  color: gray;
  padding: 0;
  display: flex;
  align-items: center;
}
编辑态-输入框样式.wd-codeEditor-root .wd-form-input-wrap组件边框、边距样式、背景色、字体大小、字体颜色等

:scope .wd-form-input-wrap {
  font-size: 20px;
  color: gray;
  text-align: right;
  height: 40px;
  width: 100%;
  background-color: lightgray;
  border-width: 2px;
  border-color: gray;
  border-radius: 0px;
}
编辑态-校验信息.wd-codeEditor-root .wd-g-text-error设置组件校验信息样式

:scope .wd-g-text-error {
    font-size: 20px;
    color: gray;
  }
提示文字.wd-codeEditor-root .wd-form-item__help-text设置组件提示文字样式

:scope .wd-form-item__help-text {
    font-size: 20px;
    color: gray;
  }
禁用态-输入框样式.wd-codeEditor-root .wd-form-input-wrap.is-disabled组件禁用样式

:scope .wd-form-input-wrap.is-disabled {
    font-size: 20px;
    color: gray;
    text-align: right;
    height: 40px;
    width: 200px;
    background-color: lightgray;
    border-width: 2px;
    border-color: gray;
    border-radius: 10px;
  }
只读态-表单值样式.wd-codeEditor-root .wd-form-item__readonly-value设置组件只读状态

:scope .wd-form-item__readonly-value {
    font-size: 20px;
    color: gray;
  }

Learn about Style API

Version Changes​

  • Property changes
  • Style changes
  • widget api changes