mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-05-20 15:33:37 +00:00
873a51fc87
- 升级 vitepress 到 ^2.0.0-alpha.17
- vite.optimizeDeps.rolldownOptions.transform.define 迁移至 vite.define 以适配 v2 API
- 同步升级 vitest/rolldown/vue/vite 等周边依赖
- 文档中类型链接统一改为 <<< 片段引用源码 region，避免 commit hash 链接失效
- packages/{core,editor,form-schema,schema,stage} 相关类型加 // #region 锚点
- 移除已废弃的 docs/guide/advanced/tmagic-ui.md 及侧栏入口
Co-authored-by: Cursor <cursoragent@cursor.com>
87 lines
4.0 KiB
Markdown
87 lines
4.0 KiB
Markdown
# Code 代码编辑器
|
|
|
|
代码编辑器字段，用于编辑代码内容。
|
|
|
|
::: warning 注意
|
|
此组件仅在编辑器环境中可用，需要配合 `@tmagic/editor` 使用。
|
|
:::
|
|
|
|
## 基础用法
|
|
|
|
```js
|
|
{
|
|
type: 'vs-code',
|
|
name: 'code',
|
|
text: '代码'
|
|
}
|
|
```
|
|
|
|
## 指定语言
|
|
|
|
```js
|
|
{
|
|
type: 'vs-code',
|
|
name: 'code',
|
|
text: '代码',
|
|
language: 'javascript'
|
|
}
|
|
```
|
|
|
|
## 自动调整大小
|
|
|
|
```js
|
|
{
|
|
type: 'vs-code',
|
|
name: 'code',
|
|
text: '代码',
|
|
autosize: {
|
|
minRows: 3,
|
|
maxRows: 10
|
|
}
|
|
}
|
|
```
|
|
|
|
## Attributes
|
|
|
|
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
|
| ------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ------ |
|
|
| name | 绑定值 | string | — | — |
|
|
| text | 表单标签 | string | — | — |
|
|
| disabled | 是否禁用 | boolean / `FilterFunction` | — | false |
|
|
| language | 代码语言 | string | javascript/typescript/json等 | — |
|
|
| height | 编辑器高度 | string | — | — |
|
|
| parse | 是否解析代码 | boolean | — | false |
|
|
| options | 编辑器配置项 | object | — | — |
|
|
| autosize | 自动调整大小配置 | object | — | — |
|
|
| mFormItemType | 传入代码编辑器的自定义类型 | string | — | — |
|
|
| onChange | 值变化时触发的函数 | `OnChangeHandler` | — | - |
|
|
|
|
::: details 查看 FilterFunction / OnChangeHandler 及关联类型定义
|
|
<<< @/../packages/form-schema/src/base.ts#FilterFunction{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#OnChangeHandler{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#OnChangeHandlerData{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#ChangeRecord{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#FormValue{ts}
|
|
:::
|
|
|
|
|
|
## 配置类型
|
|
|
|
::: details 查看 CodeConfig 配置类型定义
|
|
<<< @/../packages/form-schema/src/editor.ts#CodeConfig{ts}
|
|
|
|
<<< @/../packages/form-schema/src/base.ts#FormItem{ts}
|
|
|
|
:::
|
|
|
|
## autosize Attributes
|
|
|
|
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|
|
| ------- | -------- | ------ | ------ | ------ |
|
|
| minRows | 最小行数 | number | — | — |
|
|
| maxRows | 最大行数 | number | — | — |
|