Silver Formily Core1.0.1

简体中文

English

简体中文

English

Appearance

VoidField ​

调用createVoidField所返回的 VoidField 模型。

以下会列出主要的公开模型属性。可写属性可以直接赋值，@silver-formily/reactive 会响应并触发 UI 更新。

属性 ​

属性描述类型是否只读默认值
initialized字段是否已被初始化Boolean否true
mounted字段是否已挂载Boolean否false
unmounted字段是否已卸载Boolean否false
address字段节点路径FormPath是
path字段数据路径FormPath是
title字段标题Any（由泛型 TextType 决定）否undefined
description字段描述Any（由泛型 TextType 决定）否undefined
data字段扩展属性Object否undefined
content字段内容any否undefined
decoratorContent 1.1.0字段装饰器插槽内容any否undefined
decorator字段装饰器Any[]否[undefined, {}]
component字段组件Any[]否[undefined, {}]
parent父级字段GeneralField是undefined
display字段展示状态FieldDisplayTypes否"visible"
pattern字段交互模式FieldPatternTypes否"editable"
hidden字段是否隐藏Boolean否false
visible字段是否显示Boolean否true
disabled字段是否禁用Boolean否false
readOnly字段是否只读Boolean否false
readPretty字段是否为阅读态Boolean否false
editable字段是可编辑Boolean否true
indexes字段数字索引集合Number[]是-
index字段数字索引Number是-

详细解释 ​

initialized

VoidField 构造过程中会先将该状态设为 false。完成字段定位、状态初始化和响应式绑定后，构造函数会立即调用 onInit()，将其设为 true 并触发 onFieldInit 生命周期。因此，通过 form.createVoidField() 取得实例时，该值已经是 true。

hidden

为 true 时是 display 为 hidden，为 false 时是 display 为 visible

visible

为 true 时是 display 为 visible，为 false 时是 display 为 none

方法 ​

setTitle ​

描述 ​

设置字段标题

签名 ​

ts
interface setTitle {
  (title?: any): void
}

setDescription ​

描述 ​

设置字段描述信息

签名 ​

ts
interface setDescription {
  (title?: any): void
}

setDisplay ​

描述 ​

设置字段展示状态

签名 ​

ts
interface setDisplay {
  (display?: FieldDisplayTypes): void
}

FieldDisplayTypes 参考 FieldDisplayTypes

setPattern ​

描述 ​

设置字段交互模式

签名 ​

ts
interface setPattern {
  (pattern?: FieldPatternTypes): void
}

FieldPatternTypes 参考 FieldPatternTypes

setComponent ​

描述 ​

设置字段组件

签名 ​

ts
interface setComponent {
  (component?: FieldComponent, props?: any): void
}

FieldComponent 参考 FieldComponent

setComponentProps ​

描述 ​

设置字段组件属性

签名 ​

ts
interface setComponentProps {
  (props?: any): void
}

setDecorator ​

描述 ​

设置字段装饰器

签名 ​

ts
interface setDecorator {
  (decorator?: FieldDecorator, props?: any): void
}

FieldDecorator 参考 FieldDecorator

setDecoratorProps ​

描述 ​

设置字段装饰器属性

签名 ​

ts
interface setDecoratorProps {
  (props?: any): void
}

setState ​

描述 ​

设置字段状态

签名 ​

ts
interface setState {
  (state: IVoidFieldState): void
  (callback: (state: IVoidFieldState) => void): void
}

IVoidFieldState 参考 IVoidFieldState

getState ​

描述 ​

获取字段状态

签名 ​

ts
interface getState<T> {
  (): IVoidFieldState
  (callback: (state: IVoidFieldState) => T): T
}

IVoidFieldState 参考 IVoidFieldState

setData ​

描述 ​

设置 Data 值

签名 ​

ts
interface setData {
  (data: any): void
}

setContent ​

描述 ​

设置 Content 值

签名 ​

ts
interface setContent {
  (content: any): void
}

setDecoratorContent 1.1.0 ​

描述 ​

设置装饰器内容。Vue 绑定会将其作为装饰器插槽内容响应式渲染。

签名 ​

ts
interface setDecoratorContent {
  (content: any): void
}

onInit ​

描述 ​

触发字段初始化，默认不需要手动调用

签名 ​

ts
interface onInit {
  (): void
}

onMount ​

描述 ​

触发字段挂载

签名 ​

ts
interface onMount {
  (): void
}

onUnmount ​

描述 ​

触发字段卸载

签名 ​

ts
interface onUnmount {
  (): void
}

query ​

描述 ​

查询字段，可以基于当前字段查询相邻字段

签名 ​

ts
interface query {
  (pattern: FormPathPattern | RegExp): Query
}

FormPathPattern API 参考 FormPath

Query 对象 API 参考 Query

dispose ​

描述 ​

释放 observer，默认不需要手动释放

签名 ​

ts
interface dispose {
  (): void
}

destroy ​

描述 ​

释放 observer，并删除字段模型

签名 ​

ts
interface destroy {
  (forceClear?: boolean): void
}

match ​

描述 ​

基于路径匹配字段

签名 ​

ts
interface match {
  (pattern: FormPathPattern): boolean
}

FormPathPattern API 参考 FormPath

inject ​

描述 ​

给字段模型注入可执行方法

签名 ​

ts
interface inject {
  (actions: Record<string, (...args: any[]) => any>): void
}

invoke ​

描述 ​

调用字段模型通过 inject 注入的可执行方法

签名 ​

ts
interface invoke {
  (name: string, ...args: any[]): any
}

类型 ​

TextType ​

ts
type TextType = any

VoidField 在核心层并不单独约束标题和描述的消息类型，而是通过泛型 TextType 交给上层适配。

FieldComponent ​

ts
type FieldComponent<Component extends JSXComponent, ComponentProps = any>
  = | [Component]
    | [Component, ComponentProps]
    | boolean
    | any[]

字段组件是运行时配置槽位，通常以 [组件, 属性] 元组传入，也允许由上层适配器解释布尔值或其他数组形态。

FieldDecorator ​

ts
type FieldDecorator<Decorator extends JSXComponent, DecoratorProps = any>
  = | [Decorator]
    | [Decorator, DecoratorProps]
    | boolean
    | any[]

字段装饰器与 FieldComponent 使用相同的运行时存储形式。

FieldReaction ​

ts
type FieldReaction = (field: GeneralField) => void

FieldDisplayTypes ​

ts
type FieldDisplayTypes = 'none' | 'hidden' | 'visible' | ({} & string)

FieldPatternTypes ​

ts
type FieldPatternTypes
  = | 'editable'
    | 'readOnly'
    | 'disabled'
    | 'readPretty'
    | ({} & string)

GeneralField ​

ts
type GeneralField = Field | VoidField | ArrayField | ObjectField

Field 参考 Field

ArrayField 参考 ArrayField

ObjectField 参考 ObjectField

IVoidFieldState ​

ts
interface IVoidFieldState {
  selfDisplay?: FieldDisplayTypes
  selfPattern?: FieldPatternTypes
  content?: any
  decoratorContent?: any
  data?: any
  decoratorType?: any
  decoratorProps?: Record<string, any>
  componentType?: any
  componentProps?: Record<string, any>
  designable?: boolean
  hidden?: boolean
  visible?: boolean
  editable?: boolean
  readOnly?: boolean
  disabled?: boolean
  readPretty?: boolean
  title?: any
  description?: any
  initialized?: boolean
  mounted?: boolean
  unmounted?: boolean
  decorator?: FieldDecorator
  component?: FieldComponent
  display?: FieldDisplayTypes
  pattern?: FieldPatternTypes
  index?: number
  indexes?: number[]
}

IGeneralFieldState ​

ts
type IGeneralFieldState = IVoidFieldState & IFieldState

IFieldState 参考 IFieldState