Schema field properties
name
❗Required
Main field identifier
Can take values of type string ('name')
type
❗Required
Specifies the field data type
It can take one value from: TableFieldType
nullable
Specifies if the field must be filled in
Can take values of type boolean (true or false)
Optional property - default is: true
sortable
Allows to sort tables by field
Can take values of type boolean (true or false)
Optional property - default is: false
creatable
When creating a new entity, specifies whether to display a field for entering a value
Can take values of type boolean (true or false)
Optional property - default is: true
editable
Determines if the value in the field can be edited
Can take values of type boolean (true or false)
Optional property - default is: true
helper
Can take values of type string ('The customer's entire address for delivery of goods')
Optional property - default is: the helper icon will not appear at all
section
Allows you to set the section for the field
Can take values of type string ('userDetails' or 'financialData' or 'facturalData')
Optional property - default is: Field will be in the section: Others
virtual
Only used in combination with: type: 'virtual' and render: componentName
Can take values of type boolean (true or false)
Optional property - default is: Inactive
render
Used when you want to display a component in place of the field
Only used in combination with: type: 'virtual' and virtual: 'true'
Can take values of type TableRowCustomRender (editButton)
Optional property - default is: Inactive
grid
Allows to set the field display size
Can take values of type number (0 - 24)
Optional property - default is: 12
relation
Use to create relationships between fields
This allows you to set dependencies and relationships from your api/database
Optional property - default is: Inactive
It has two required attributes: type and entity (see below)
type
❗Required
Defines the relationship
Relationships: ( One-to-one, One-to-many, Many-to-many)
Can take values of type RelationType ('many' or 'one')
entity
❗Required
Specifies the name of the entity to be linked to
Can take values of type string ('car')
Last updated