Skip to content

SubForm

A complex layout subform component for list (array) type form data that supports nesting of complex layouts.

API

Use getComponent(Subform ID) to get the subform component instance for invocation.

setData

  • (rowIndex, data: object | {}) => Promise

    Set a row of data in the subform

hide

  • (fields: []) => void

    Hide the columns of the subform

hideChild

  • (rowIndex, fields) => void

    Hide the specific number of rows in the subform

display

  • (fields: []) => void

    Display the columns of the subform

displayChild

  • (rowIndex, fields) => void

    Display the specific number of rows in the subform

disabled

  • (fields, disabled: true | false) => void

    Disable/Enable columns of a subform

disabledChild

  • (rowIndex, fields, disabled: true | false) => void

    Disable/Enable the specific number of rows in the subform

handleAddRow

  • () => void

    Adds row to the subform

handleRemove

  • (rowIndex) => void

    Remove the specific number of row in the subform

setOptions

  • (fields, options) => void

    Set the field configuration items in the subform

addClassName

  • (fields: [], className) => void

    Adds a style class to a field item in a subform

removeClassName

  • (fields: [], className) => void

    Removes the subform field style class