grid

Arranges content as tiles, arranged from top left to bottom right.

Field Configurations

Key	Type	Description	Default Value
"children"	Array	List of child layers.	null
"columns"	Number	The number of columns.	12
"consumesKeyboard"	Boolean	If 'true' is set, the grid adjusts automatically when the keyboard is opened. iOS only.	false
"displayMode"	DisplayMode	Determines in which way the elements should be loaded.	"eager"
"fullyVisible"	String	Specifies whether to fire the scroll event when an element is visible or only when it is fully visible.	null
"horizontalItemSpacing"	UnitSize	Spacing between elements in the horizontal direction	0
"insets"	Object	Insets the content of the grid by the given values.	null
"scrollDirection"	String	The direction in which the grid scrolls.	null
"scrollEvent"	String	Event that is fired while scrolling	null
"scrollOnAppear"	String	The grid will automatically scroll to the set value when it appears.	"none"
"scrolling"	Boolean	Indicates if scrolling is allowed	true
"verticalItemSpacing"	UnitSize	Spacing between elements in the vertical direction	0
"verticalScrollIndicator"	Boolean	Specifies whether a scroll indicator should be displayed.	false

Inherited

From Base Layer

Base Layer

Field Configurations

Key	Type	Description	Default Value
"_value"	Value	[PREVIEW] Dynamic value of the layer.	null
"accessibilityAppendState"	String	Defines this layer appends its state to the accessibility text.	null
"accessibilityText"	String	Text for accessibility navigation. Can be translated.	null
"actions"	ActionList	List of actions, which will be executed when the layer is tapped.	null
"borderColor"	Color	The color of the border in hex color value.	null
"borderRadius"	UnitSize	The radius applies to all corners; with a borderWidth of 0 the border is not drawn and radius is set anyway.	0
"borderWidth"	UnitSize	The width of the border.	0
"bottomLeftRadius"	UnitSize	Radius for the bottom left corner.	0
"bottomRightRadius"	UnitSize	Radius for the bottom right corner.	0
"classes"	Array	List of classes for layer styles.	null
"conditions"	Conditions	List of conditions to alter the layer state.	null
"constraints"	Constraints	A list of constraints defining the position of the layer in a layout.	null
"consumesKeyboard"	Boolean	This layer will be used to shrink, if a keyboard is shown.	null
"dataKey"	String	Name for assigning data to this layer.	null
"focusColor"	Color	The highlight color of this layer when it is focused. Mainly used on TV. If no color is provided, the pressedColor will be used.	null
"hidden"	Boolean	Indicates whether the layer is hidden. Default: false.	false
"isAccessibilityElement"	String	Defines if this layer is important for accessibility navigation. The default depends on the layer type.	null
"layerRotation"	Number	The layer is rotated by the specified degree.	0
"name"	String	Unique name in the layout. Used for alignment or actions.	null
"opacity"	Number	The opacity of the layer.	1
"overInsetBottom"	Boolean	Determines if this layer ignores the save space at the bottom of the device.	false
"overInsetTop"	Boolean	Determines if this layer ignores the save space at the top of the device.	false
"pressedColor"	Color	The highlight color of this layer when it is pressed. Mainly used on TV. If no color is provided, the focusColor will be used.	null
"safeArea"	SafeAreaTypeObject	Determines the safe area behaviour.	null
"shadowElevation"	Number	The elevation of this layer for casting shadows.	0
"state"	String	The state the layer will use as default.	"default"
"states"	LayerStates	A list of named states that affect the appearance of the layer.	null
"topLeftRadius"	UnitSize	Radius for the top left corner.	0
"topRightRadius"	UnitSize	Radius for the top right corner.	0
"touchFeedback"	TouchFeedback	Determines if the layer should show a touch feedback if touched.	"visible"
"trackingKey"	String	Defines a key for a scroll event.	null
"type"	LayerType	The type of the layer	null
"value"	Value	(Initial) value of the layer.	null

Examples

Example 1: Create a grid with three children

Goal: Creates a three-color container on the grid.

The following code can be used to accomplish this:

{
  "type": "grid",
  "columns": "12",
  "constraints": [
    {
      "type": "pos",
      "x": "0",
      "y": "0"
    },
    {
      "type": "size",
      "width": "100%",
      "height": "100%"
    }
  ],
  "children": [
    {
      "type": "container",
      "constraints": [
        {
          "type": "grid",
          "colSpan": "3",
          "aspectRatio": "8"
        }
      ],
      "children": [
        {
          "type": "color",
          "value": "#6d7070",
          "constraints": [
            {
              "type": "pos",
              "x": 0,
              "y": 0
            },
            {
              "type": "pos",
              "x": 0,
              "y": 0,
              "anchor": "se",
              "relativeAnchor": "se"
            }
          ]
        }
      ]
    },
    {
      "type": "container",
      "constraints": [
        {
          "type": "grid",
          "colSpan": "9",
          "aspectRatio": "8"
        }
      ],
      "children": [
        {
          "type": "color",
          "value": "#34a7c9",
          "constraints": [
            {
              "type": "pos",
              "x": 0,
              "y": 0
            },
            {
              "type": "pos",
              "x": 0,
              "y": 0,
              "anchor": "se",
              "relativeAnchor": "se"
            }
          ]
        }
      ]
    },
    {
      "type": "container",
      "constraints": [
        {
          "type": "grid",
          "colSpan": "12",
          "aspectRatio": "4"
        }
      ],
      "children": [
        {
          "type": "color",
          "value": "#f3f3f3",
          "constraints": [
            {
              "type": "pos",
              "x": 0,
              "y": 0
            },
            {
              "type": "pos",
              "x": 0,
              "y": 0,
              "anchor": "se",
              "relativeAnchor": "se"
            }
          ]
        }
      ]
    }
  ]
}

If the sum of children's colSpans is greater than 12, the next children will be moved one step below.

Result:

A grid layer with three children has been created.

Example 2: Create a grid and add 'insert' as a child to display dynamic data.

Goal: Create a grid and add an insert layer to retrieve images from a database table and display them.

1. Add a grid layer to the layout:

{
  "type": "grid",
  "columns": "12",
  "classes": [
    "fullSize"
  ],
  "children": [
    {
      "name": "images",
      "type": "insert",
      "source": "query",
      "sourceParams": {
        "table": "images",
        "query": "all",
        "layout": "i_image",
        "template": "imageInsert",
        "columnSpan": "12",
        "aspectRatio": "3.5"
      }
    }
  ]
}

A full-screen grid with an insert layer as a child has been created. It is not functioning yet, because the following components have not yet been created:
1.table:images and query: all in it.
2.layout:i_image.
3.client_template: imageInsert

2. Create a database table with queries:

{
  "table": {
    "name": "images",
    "fields": [
      {
        "name": "ID",
        "type": "TEXT"
      },
      {
        "name": "image_url",
        "type": "TEXT"
      }
    ],
    "primaryKey": [
      "ID"
    ],
    "queries": {
      "all": {
        "custom": "SELECT * FROM images"
      },
      "byId": {
        "custom": "SELECT * FROM images WHERE images.ID = ?"
      }
    }
  },
  "data": [
    {
      "ID": 1,
      "image_url": "http://res.appframework.de/media/demo/image1.png"
    },
    {
      "ID": 2,
      "image_url": "http://res.appframework.de/media/demo/image2.jpg"
    },
    {
      "ID": 3,
      "image_url": "http://res.appframework.de/media/demo/image3.jpg"
    }
  ]
}

3. Create a i_image layout:

{
  "name": "i_image",
  "layers": [
    {
      "type": "container",
      "classes": [
        "fullSize"
      ],
      "children": [
        {
          "type": "image",
          "dataKey": "myImage",
          "scaleType": "scaleAspectFill",
          "classes": [
            "fullSize"
          ]
        }
      ]
    }
  ]
}

4. Create a client template to display the value from the database table in the i_image layout:

{
  "name": "imageInsert",
  "content": {
    "myImage": {
      "value": "{{image_url}}"
    }
  }
}

Result:

A grid layer has been created with an insert layer as a child to display dynamic data.