Components

entity

6min

The entity component is a container for the following components:
﻿entity-field﻿﻿
﻿entity-field﻿﻿
﻿section﻿﻿
Considerations
The component.entity used with the above-mentioned components is configurable on a jig.default.
 Section﻿ and field-row﻿ are also available under the component.form as its container. Here the entity-field﻿ is replaced by the form's﻿ children field. 
When setting up a component.entity, either a default jig﻿ or component.form can be used in the following combinations:
An entity containing section(s)﻿ with rows﻿ and entity-field﻿﻿
An entity containing section(s)﻿ and entity-field﻿﻿
An entity containing rows﻿ and entity-field﻿﻿
An entity containing entity fields﻿﻿
﻿Configuration options﻿
﻿
Other options
﻿
isCompact
When this property is set to true the entity-field will cover the entire row. This compact variant does not allow usage of field-row components. By default, a label is at the top and the value below. isCompact will place the label on the left and the value on the right. Columns are not supported.
﻿Examples and code snippets ﻿
Basic
Entity with sections, row & field
﻿
Compact
Entity with sections & field
﻿
Examples:
Basic - See the full example using static data in GitHub.
Compact - See the full example using dynamic data in GitHub.
Basic-entity-section-row-entity-field
Compact-entity-section-entity-field
Datasource (dynamic)
datasources:
  cleaning-services:
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
  
      entities:
        - entity: default/cleaning-services
  
      query: |
        SELECT 
          id, 
          '$.area', 
          '$.description', 
          '$.hourlyrate', 
          '$.illustration', 
          '$.image', 
          '$.indoor', 
          '$.onceoffrate', 
          '$.service', 
          '$.time' 
        FROM [default/cleaning-services] ORDER BY '$.service' ASC
datasources:
  cleaning-services:
    type: datasource.sqlite
    options:
      provider: DATA_PROVIDER_DYNAMIC
  
      entities:
        - entity: default/cleaning-services
  
      query: |
        SELECT 
          id, 
          '$.area', 
          '$.description', 
          '$.hourlyrate', 
          '$.illustration', 
          '$.image', 
          '$.indoor', 
          '$.onceoffrate', 
          '$.service', 
          '$.time' 
        FROM [default/cleaning-services] ORDER BY '$.service' ASC
﻿
See also
﻿entity-field﻿ 
﻿field-row﻿ 
﻿﻿﻿section﻿ ﻿ 
﻿

Other options
isCompact	When this property is set to true the entity-field will cover the entire row. This compact variant does not allow usage of field-row components. By default, a label is at the top and the value below. isCompact will place the label on the left and the value on the right. Columns are not supported.

divider

entity-field

entity

Considerations

﻿Configuration options﻿

Other options

﻿Examples and code snippets ﻿

Entity example

See also

Configuration options

Examples and code snippets