Back to Nocobase

VariableJsonTextArea

docs/docs/cn/shared-components/form/variable-json-text-area.md

2.1.241.4 KB
Original Source

VariableJsonTextArea

VariableJsonTextArea 用来编辑带变量的 JSON 配置。它基于 JsonTextArea,在右上角加了一个变量选择按钮,选中变量后会把 {{ ... }} 表达式插入当前光标位置。

如果 JSON 配置里不需要变量,直接用 JsonTextArea 更简单。

基本用法

tsx
tsx
import { VariableJsonTextArea } from '@nocobase/client-v2';

<VariableJsonTextArea
  json5
  rows={8}
  namespaces={['$env', '$user']}
  value={{ endpoint: '{{ $env.API_ENDPOINT }}' }}
  onChange={(value) => {
    console.log(value);
  }}
/>;

API

VariableJsonTextArea 继承 JsonTextArea 的参数,另外支持:

参数类型说明
namespacesstring[]限定变量选择器里的顶层命名空间
extraNodesMetaTreeNode[]追加局部变量节点
metaTreeMetaTreeNode[] | () => MetaTreeNode[] | Promise<MetaTreeNode[]>完全自定义变量树
delimiters[string, string]变量分隔符,默认 ['{{', '}}']
formatPathToValue(meta) => string | undefined自定义变量路径格式化

相关链接