Documents / @faasjs/ant-design / UnionFaasItemProps

Interface: UnionFaasItemProps<Value, Values>

Interface representing the properties of a UnionFaas item.

The UnionFaas item can be used in a form, description, or table.

Render Priority Order

Null Rendering (Notice: it also doesn't render column in table and description)
1. Returns null if specific children or render props are null:
  - formChildren / descriptionChildren / tableChildren / formRender / descriptionRender / tableRender
2. Returns null if children or render prop is null
Children Rendering
1. First priority: Component-specific children
  - formChildren for Form
  - descriptionChildren for Description
  - tableChildren for Table
2. Second priority: Generic children prop
Custom Render Functions
1. First priority: Component-specific render functions
  - formRender for Form
  - descriptionRender for Description
  - tableRender for Table
2. Second priority: Generic render prop
Extended Types
- Renders based on registered extended type handlers
Default Rendering
- Renders primitive types (string, number, etc.)
- Uses default formatting based on data type

Example

import { type UnionFaasItemProps, Form, Table, Description } from '@faasjs/ant-design'

const item: UnionFaasItemProps[] = [
  {
    id: 'id',
    formChildren: null, // Don't show in form, only in description and table
  },
  {
    id: 'name',
    required: true, // Required in form
  },
  {
    id: 'age',
    type: 'number', // Number type in form, description and table
    options: ['< 18', '>= 18'], // Options in form and table
  }
]

const data = {
  id: '1',
  name: 'John',
  age: '>= 18',
}

function App() {
  return <>
    <Form items={item} /> // Use in form
    <Description items={item} dataSource={data} /> // Use in description
    <Table items={item} dataSource={[ data ]} /> // Use in table
  </>
}

Extends

FormItemProps.DescriptionItemProps.TableItemProps

Type Parameters

Value

Value = any

Values

Values = any

Properties

children?

optional children: UnionFaasItemElement<Value, Values>

Overrides

TableItemProps.children

col?

optional col: number

Inherited from

FormItemProps.col

descriptionChildren?

optional descriptionChildren: UnionFaasItemElement<any>

Inherited from

DescriptionItemProps.descriptionChildren

descriptionRender?

optional descriptionRender: UnionFaasItemRender<any>

Inherited from

DescriptionItemProps.descriptionRender

disabled?

optional disabled: boolean

Inherited from

FormItemProps.disabled

extendTypes?

optional extendTypes: ExtendTypes

Inherited from

FormItemProps.extendTypes

formChildren?

optional formChildren: UnionFaasItemElement<any>

Inherited from

FormItemProps.formChildren

formRender?

optional formRender: UnionFaasItemRender<any>

Inherited from

FormItemProps.formRender

id

id: string

Inherited from

TableItemProps.id

if()?

optional if: (values) => boolean

trigger when any item's value changed

Parameters

values

Record<string, any>

Returns

boolean

Inherited from

DescriptionItemProps.if

input?

optional input: SelectProps<any, DefaultOptionType> | InputProps | RadioProps | InputNumberProps<ValueType> | SwitchProps | DatePickerProps