GridView

Overview

API Reference: UI.GridView

A Gridview lays out children in a staggered grid formation. It supports horizontal & vertical layout as well as an ability to layout children in reverse.

note

The components in the example are added from the code for better showcase purposes. To learn more about the subject you can refer to:

Adding Component From Code

As a best practice, Smartface recommends using the WYSIWYG editor in order to add components and styles to your page or library. To learn how to use UI Editor better, please refer to this documentation

UI Editor Basics

scripts/pages/gridViewSample.ts

import GridViewSampleDesign from "generated/pages/gridViewSample";
import Color from "@smartface/native/ui/color";
import Label from "@smartface/native/ui/label";
import GridView from "@smartface/native/ui/gridview";
import GridViewItem from "@smartface/native/ui/gridviewitem";
import LayoutManager from "@smartface/native/ui/layoutmanager";
import Application from "@smartface/native/application";
import Screen from "@smartface/native/device/screen";
import { Route, Router } from "@smartface/router";
import { styleableComponentMixin } from "@smartface/styling-context";
import TextAlignment from "@smartface/native/ui/shared/textalignment";
import { IColor } from "@smartface/native/ui/color/color";
import System from "@smartface/native/device/system";

class StyleableGridView extends styleableComponentMixin(GridView) {}
class StyleableGridViewItem extends styleableComponentMixin(GridViewItem) {}
class StyleableLabel extends styleableComponentMixin(Label) {}

type DatasetType = { title: String; backgroundColor: IColor };
const SPAN_COUNT: number = 2;
const COLORS: string[] = [
  "#ffffff",
  "#e6f7ff",
  "#cceeff",
  "#b3e6ff",
  "#99ddff",
  "#80d4ff",
  "#66ccff",
  "#4dc3ff",
  "#33bbff",
  "#1ab2ff",
  "#00aaff",
  "#0099e6",
  "#0088cc",
  "#0077b3",
  "#006699",
];

//You should create new Page from UI-Editor and extend with it.
export default class GridViewSample extends GridViewSampleDesign {
  myGridView: StyleableGridView;
  layoutManager: LayoutManager;
  constructor(private router?: Router, private route?: Route) {
    super({});
  }

  generateDataset(): DatasetType[] {
    let dataset: DatasetType[] = [];
    for (let i = 0; i < 12; ++i) {
      dataset.push({
        title: `Smartface Title ${i}`,
        backgroundColor: Color.create(COLORS[i % COLORS.length]),
      });
    }
    return dataset;
  }

  onShow() {
    super.onShow();
    const { headerBar } =
      System.OS === System.OSType.ANDROID ? this : this.parentController;
    Application.statusBar.visible = false;
    headerBar.visible = false;
  }

  onLoad() {
    super.onLoad();

    let myDataSet: DatasetType[] = this.generateDataset();

    this.layoutManager = new LayoutManager({
      spanCount: SPAN_COUNT,
      scrollDirection: LayoutManager.ScrollDirection.VERTICAL,
      onItemLength: function () {
        // Make sure GridViewItem's are square sized
        return Screen.width / SPAN_COUNT;
      },
    });

    let index = 0;
    this.myGridView = new StyleableGridView({
      layoutManager: this.layoutManager,
      refreshEnabled: true,
      itemCount: myDataSet.length,
      scrollBarEnabled: false,
      onItemCreate: () => {
        let gridViewItem = new StyleableGridViewItem();
        let myLabel = new StyleableLabel({
          flexGrow: 1,
          textAlignment: TextAlignment.MIDCENTER,
        });
        this.myGridView.dispatch({
          type: "addChild",
          component: gridViewItem,
          name: `gridViewItem${++index}`,
        });
        //@ts-ignore
        gridViewItem.myLabel = myLabel;
        gridViewItem.addChild(myLabel);
        return gridViewItem;
      },
      onItemBind: (gridViewItem, index) => {
        const { title, backgroundColor }: DatasetType = myDataSet[index];
        //@ts-ignore
        gridViewItem.myLabel.text = title;
        //@ts-ignore
        gridViewItem.myLabel.backgroundColor = backgroundColor;
      },
      onItemSelected: (gridViewItem) => {
        //@ts-ignore
        console.log(`Item title : ${gridViewItem.myLabel.text}`);
      },
      onPullRefresh: () => {
        console.log("onPullRefresh");
      },
      onScroll: () => {
        console.log("onScroll");
      },
    });

    this.addChild(this.myGridView, "myGridView", ".gridView", {
      width: Screen.width,
      height: Screen.height,
      marginTop: 0,
      marginBottom: 0,
    });
    this.style.apply({
      paddingTop: 0,
      paddingLeft: 0,
      paddingBottom: 0,
      paddingRight: 0,
    });
  }
}

Advanced Usage

Sample project implemented using GridView is available. You can check that out.

Adjust GridView Item Span

GridView can be full span with LayoutManager callback function, onFullSpan, that makes the cell full. While using layout manager if scroll direction is vertical, height must be return value; if layout manager scroll direction is horizontal width must be return value. If return value is undefined it means nothing will be modified.

note

The components in the example are added from the code for better showcase purposes. To learn more about the subject you can refer to:

Adding Component From Code

As a best practice, Smartface recommends using the WYSIWYG editor in order to add components and styles to your page or library. To learn how to use UI Editor better, please refer to this documentation

UI Editor Basics

scripts/pages/gridViewSample.ts

import GridViewSampleDesign from "generated/pages/gridViewSample";
import Color from "@smartface/native/ui/color";
import Label from "@smartface/native/ui/label";
import GridView from "@smartface/native/ui/gridview";
import GridViewItem from "@smartface/native/ui/gridviewitem";
import LayoutManager from "@smartface/native/ui/layoutmanager";
import Application from "@smartface/native/application";
import Screen from "@smartface/native/device/screen";
import { Route, Router } from "@smartface/router";
import { withDismissAndBackButton } from "@smartface/mixins";
import { styleableComponentMixin } from "@smartface/styling-context";
import { IColor } from "@smartface/native/ui/color/color";
import TextAlignment from "@smartface/native/ui/shared/textalignment";
import System from "@smartface/native/device/system";

class StyleableGridView extends styleableComponentMixin(GridView) {}
class StyleableGridViewItem extends styleableComponentMixin(GridViewItem) {}
class StyleableLabel extends styleableComponentMixin(Label) {}

type DatasetType = { title: String; backgroundColor: IColor };
const SPAN_COUNT: number = 2;
const COLORS: string[] = [
  "#ffffff",
  "#e6f7ff",
  "#cceeff",
  "#b3e6ff",
  "#99ddff",
  "#80d4ff",
  "#66ccff",
  "#4dc3ff",
  "#33bbff",
  "#1ab2ff",
  "#00aaff",
  "#0099e6",
  "#0088cc",
  "#0077b3",
  "#006699",
];
//You should create new Page from UI-Editor and extend with it.
export default class GridViewSample extends withDismissAndBackButton(
  GridViewSampleDesign
) {
  myGridView: StyleableGridView;
  layoutManager: LayoutManager;
  index: number = 0;
  constructor(private router?: Router, private route?: Route) {
    super({});
  }

  generateDataset(): DatasetType[] {
    let dataset: DatasetType[] = [];
    for (let i = 0; i < 12; ++i) {
      dataset.push({
        title: `Smartface Title ${i}`,
        backgroundColor: Color.create(COLORS[i % COLORS.length]),
      });
    }
    return dataset;
  }

  onShow() {
    const { headerBar } =
      System.OS === System.OSType.ANDROID ? this : this.parentController;
    super.onShow();
    Application.statusBar.visible = false;
    headerBar.visible = false;
  }

  onLoad() {
    super.onLoad();
    let myDataSet: DatasetType[] = this.generateDataset();

    this.layoutManager = new LayoutManager({
      spanCount: SPAN_COUNT,
      scrollDirection: LayoutManager.ScrollDirection.VERTICAL,
      onItemLength: function () {
        // Make sure GridViewItem's are square sized
        return Screen.width / SPAN_COUNT;
      },
      onFullSpan: function (type) {
        if (type == 1) {
          return 200;
        } else if (type == 2) {
          return 50;
        }
        return undefined;
      },
    });
    this.myGridView = new StyleableGridView({
      layoutManager: this.layoutManager,
      refreshEnabled: true,
      backgroundColor: Color.TRANSPARENT,
      flexGrow: 1,
      itemCount: myDataSet.length,
      scrollBarEnabled: false,
      onItemType: function (index) {
        if (index === 0) {
          return 1;
        } else if (index === 1) {
          return 2;
        }
        return 3;
      },
      onItemCreate: () => {
        let gridViewItem = new StyleableGridViewItem();
        let myLabel = new StyleableLabel({
          flexGrow: 1,
          textAlignment: TextAlignment.MIDCENTER,
        });

        this.myGridView.dispatch({
          type: "addChild",
          component: gridViewItem,
          name: `gridViewItem${++this.index}`,
        });
        gridViewItem.addChild(myLabel);
        //@ts-ignore
        gridViewItem.myLabel = myLabel;
        return gridViewItem;
      },
      onItemBind: function (gridViewItem, index) {
        let { title, backgroundColor } = myDataSet[index];
        //@ts-ignore
        gridViewItem.myLabel.text = title;
        //@ts-ignore
        gridViewItem.myLabel.backgroundColor = backgroundColor;
      },
      onItemSelected: function (gridViewItem, index) {
        //@ts-ignore
        console.log(`Item title : ${gridViewItem.myLabel.text}`);
      },
      onPullRefresh: function () {
        console.log("onPullRefresh");
      },
      onScroll: function () {
        console.log("onScroll");
      },
    });

    this.addChild(this.myGridView, "myGridView", ".gridView", {
      width: Screen.width,
      height: Screen.height,
      marginTop: 0,
      marginBottom: 0,
    });
    this.style.apply({
      paddingTop: 0,
      paddingLeft: 0,
      paddingBottom: 0,
      paddingRight: 0,
    });
  }
}

GridView Dynamic Span

  initGridView(): void {
    this.gridView1.layoutManager.spanCount = 1;
    this.gridView1.layoutManager.scrollDirection = LayoutManager.ScrollDirection.HORIZONTAL;
    this.gridView1.layoutManager.onFullSpan = (type) => {
      console.info('onFullSpan');
      let dimensions = {
        labelWidth: myLabel.width
      };
      return this.getWidth(dimensions);
    };
    this.gridView1.itemCount = 10;
    this.gridView1.refreshData();
  }
  getWidth(dimensions: { labelWidth: number }): number {
    return Math.round(dimensions.labelWidth);
  }

Display Data In Cards

To show information inside cards that have a consistent look View can be customized. Pagination and snapping behaviors are given to GridView while scrolling. Snapping allows to lock the viewport to certain elements or locations after a user has finished scrolling. This helps to swipe GridView cells.

note

The components in the example are added from the code for better showcase purposes. To learn more about the subject you can refer to:

Adding Component From Code

As a best practice, Smartface recommends using the WYSIWYG editor in order to add components and styles to your page or library. To learn how to use UI Editor better, please refer to this documentation

UI Editor Basics

scripts/pages/gridViewSample.ts

import GridViewSampleDesign from "generated/pages/gridViewSample";
import Color from "@smartface/native/ui/color";
import Label from "@smartface/native/ui/label";
import GridView from "@smartface/native/ui/gridview";
import GridViewItem from "@smartface/native/ui/gridviewitem";
import LayoutManager from "@smartface/native/ui/layoutmanager";
import Application from "@smartface/native/application";
import System from "@smartface/native/device/system";
import { Route, Router } from "@smartface/router";
import { styleableComponentMixin } from "@smartface/styling-context";
import { IColor } from "@smartface/native/ui/color/color";
import TextAlignment from "@smartface/native/ui/shared/textalignment";
import { DecelerationRate } from "@smartface/native/ui/gridview/gridview";

class StyleableGridView extends styleableComponentMixin(GridView) {}
class StyleableGridViewItem extends styleableComponentMixin(GridViewItem) {}
class StyleableLabel extends styleableComponentMixin(Label) {}

type DatasetType = { title: String; backgroundColor: IColor };
const SPAN_COUNT: number = 1;
const COLORS: string[] = [
  "#ffffff",
  "#e6f7ff",
  "#cceeff",
  "#b3e6ff",
  "#99ddff",
  "#80d4ff",
  "#66ccff",
  "#4dc3ff",
  "#33bbff",
  "#1ab2ff",
  "#00aaff",
  "#0099e6",
  "#0088cc",
  "#0077b3",
  "#006699",
];
const ITEM_WIDTH: number = 150;
//You should create new Page from UI-Editor and extend with it.
export default class GridViewSample extends GridViewSampleDesign {
  myGridView: StyleableGridView;
  layoutManager: LayoutManager;
  index: number = 0;
  constructor(private router?: Router, private route?: Route) {
    super({});
  }

  generateDataset(): DatasetType[] {
    let dataset: DatasetType[] = [];
    for (let i = 0; i < 12; ++i) {
      dataset.push({
        title: `Smartface Title ${i}`,
        backgroundColor: Color.create(COLORS[i % COLORS.length]),
      });
    }
    return dataset;
  }

  /**
   * @event onShow
   * This event is called when a page appears on the screen (everytime).
   * @param {function} superOnShow super onShow function
   * @param {Object} parameters passed from Router.go function
   */
  onShow() {
    const { headerBar } =
      System.OS === System.OSType.ANDROID ? this : this.parentController;
    super.onShow();
    Application.statusBar.visible = false;
    headerBar.visible = false;
  }

  /**
   * @event onLoad
   * This event is called once when page is created.
   * @param {function} superOnLoad super onLoad function
   */
  onLoad() {
    super.onLoad();
    let myDataSet: DatasetType[] = this.generateDataset();

    this.layoutManager = new LayoutManager({
      spanCount: SPAN_COUNT,
      scrollDirection: LayoutManager.ScrollDirection.HORIZONTAL,
      onItemLength: function () {
        return ITEM_WIDTH;
      },
    });

    this.layoutManager.ios.targetContentOffset = (
      proposedContentOffset,
      velocity
    ) => {
      let positionX = this.myGridView.contentOffset.x / ITEM_WIDTH;
      let decimalPositionX = positionX;
      let precisionPositionX = positionX % 1;

      if (velocity.x == 0 && precisionPositionX >= 0.5) {
        decimalPositionX = decimalPositionX + 1;
      } else if (velocity.x > 0) {
        decimalPositionX = decimalPositionX + 1;
      }

      return { x: decimalPositionX * ITEM_WIDTH, y: 0 };
    };
    this.myGridView = new StyleableGridView({
      layoutManager: this.layoutManager,
      itemCount: myDataSet.length,
      scrollBarEnabled: false,
      onItemCreate: () => {
        var gridViewItem = new StyleableGridViewItem();
        gridViewItem.paddingLeft = 20;
        var myLabel = new StyleableLabel({
          flexGrow: 1,
          textAlignment: TextAlignment.MIDCENTER,
        });
        gridViewItem.addChild(myLabel);
        this.myGridView.dispatch({
          type: "addChild",
          component: gridViewItem,
          name: `gridViewItem${++this.index}`,
        });
        //@ts-ignore
        gridViewItem.myLabel = myLabel;
        return gridViewItem;
      },
      onItemBind: function (gridViewItem, index) {
        var { title, backgroundColor } =
          myDataSet[myDataSet.length - index - 1];
        //@ts-ignore
        gridViewItem.myLabel.text = title;
        //@ts-ignore
        gridViewItem.myLabel.backgroundColor = backgroundColor;
      },
      onItemSelected: function (gridViewItem, index) {
        //@ts-ignore
        console.log(`Item title : ${gridViewItem.myLabel.text}`);
      },
      onPullRefresh: function () {
        console.log("onPullRefresh");
      },
      onScroll: function (contentOffset) {},
    });

    this.myGridView.ios.decelerationRate = DecelerationRate.FAST;
    this.myGridView.refreshEnabled = false;

    if (System.OS === System.OSType.ANDROID)
      this.myGridView.android.snapToAlignment =
        GridView.Android.SnapAlignment.SNAPTO_START;

    this.layoutManager.contentInset = { top: 0, left: 0, bottom: 0, right: 20 };

    this.addChild(this.myGridView, "myGridView", ".gridView", {
      height: 200,
    });
    this.style.apply({
      paddingTop: 100,
      paddingLeft: 0,
      paddingBottom: 0,
      paddingRight: 0,
    });
  }
}

Scroll Position State

Please note that while navigating to another page or just using GridView component as ListViewItem (inner usages), the page lose its scroll position state.
To keep the scroll position state the same, we provide methods to save and restore the state; Checkout saveInstanceState() & restoreInstanceState(state).
Its recommended to checkout onAttachedToWindow() & onDetachedFromWindow( ) as well.

Insert, Delete and Refresh Row Dynamically

You can insert a row at any position by using insertRowRange method.

You can delete a row at any position by using deleteRowRange method.

You can refresh a row at any position by using refreshRowRange method.

note

The components in the example are added from the code for better showcase purposes. To learn more about the subject you can refer to:

Adding Component From Code

As a best practice, Smartface recommends using the WYSIWYG editor in order to add components and styles to your page or library. To learn how to use UI Editor better, please refer to this documentation

UI Editor Basics

Main Codebase (Insert)

scripts/pages/GridViewExample.ts

import GridViewExample from "generated/pages/GridViewExample";
import Router from "@smartface/router/lib/router/Router";
import { Route } from "@smartface/router";
import Color from "@smartface/native/ui/color";
import GridView from "@smartface/native/ui/gridview";
import GridViewItem from "@smartface/native/ui/gridviewitem";
import LayoutManager from "@smartface/native/ui/layoutmanager";
import Label from "@smartface/native/ui/label";
import {
  styleableComponentMixin,
  styleableContainerComponentMixin,
} from "@smartface/styling-context";
import System from "@smartface/native/device/system";
import { IColor } from "@smartface/native/ui/color/color";
import TextAlignment from "@smartface/native/ui/shared/textalignment";
import Application from "@smartface/native/application";

class StyleableGridView extends styleableComponentMixin(GridView) {}
class StyleableGridViewItem extends styleableContainerComponentMixin(
  GridViewItem
) {}
class StyleableLabel extends styleableComponentMixin(Label) {}

type DatasetType = { title: String; backgroundColor: IColor };
const SPAN_COUNT: number = 2;
const COLORS: string[] = [
  "#ffffff",
  "#e6f7ff",
  "#cceeff",
  "#b3e6ff",
  "#99ddff",
  "#80d4ff",
  "#66ccff",
  "#4dc3ff",
  "#33bbff",
  "#1ab2ff",
  "#00aaff",
  "#0099e6",
  "#0088cc",
  "#0077b3",
  "#006699",
];
const ITEM_WIDTH: number = 150;

export default class GridViewExamplePage extends GridViewExample {
  routeData: any;
  parentController: any;
  myGridView: StyleableGridView;
  myDataSet: DatasetType[];
  layoutManager: LayoutManager;
  index: number = 0;

  private disposeables: (() => void)[] = [];
  constructor(private router?: Router, private route?: Route) {
    super({});
  }

  changeDataset() {
    this.myDataSet.unshift({ title: "New Item", backgroundColor: Color.RED });
  }

  generateDataset(): DatasetType[] {
    let dataset: DatasetType[] = [];
    for (let i = 0; i < 12; ++i) {
      dataset.push({
        title: `Smartface Title ${i}`,
        backgroundColor: Color.create(COLORS[i % COLORS.length]),
      });
    }
    return dataset;
  }

  initGridView() {
    this.myGridView = new StyleableGridView({
      layoutManager: this.layoutManager,
      refreshEnabled: true,
      itemCount: this.myDataSet.length,
      scrollBarEnabled: false,
      onItemCreate: () => {
        let gridViewItem = new StyleableGridViewItem();
        gridViewItem.paddingLeft = 20;
        let myLabel = new StyleableLabel({
          flexGrow: 1,
          textAlignment: TextAlignment.MIDCENTER,
        });
        gridViewItem.addChild(myLabel);
        this.myGridView.dispatch({
          type: "addChild",
          component: gridViewItem,
          name: `gridViewItem${++this.index}`,
        });
        //@ts-ignore
        gridViewItem.myLabel = myLabel;
        return gridViewItem;
      },
      onItemBind: (gridViewItem, index) => {
        var { title, backgroundColor } = this.myDataSet[index];
        //@ts-ignore
        gridViewItem.myLabel.text = title;
        //@ts-ignore
        gridViewItem.myLabel.backgroundColor = backgroundColor;
      },
      onItemSelected: (gridViewItem, index) => {
        //@ts-ignore
        console.log(`Item title : ${gridViewItem.myLabel.text}`);
        this.changeDataset();
        console.info("item selected ", this.myDataSet);
        this.myGridView.itemCount = this.myDataSet.length;
        this.myGridView.insertRowRange({ positionStart: 0, itemCount: 1 });
        // Workaround
        if (System.OS === System.OSType.ANDROID) {
          this.myGridView.scrollTo(0);
        }
      },
      onPullRefresh: () => {},
    });
    this.addChild(this.myGridView, "myGridView", "gridView", {
      height: 200,
    });
    this.style.apply({
      paddingTop: 100,
      paddingLeft: 0,
      paddingBottom: 0,
      paddingRight: 0,
    });
  }

  /**
   * @event onShow
   * This event is called when a page appears on the screen (everytime).
   */
  onShow() {
    super.onShow();
    const { headerBar } =
      System.OS === System.OSType.ANDROID ? this : this.parentController;
    Application.statusBar.visible = false;
    headerBar.visible = false;
  }

  /**
   * @event onLoad
   * This event is called once when page is created.
   */
  onLoad() {
    super.onLoad();
    this.myDataSet = this.generateDataset();
    this.layoutManager = new LayoutManager({
      spanCount: SPAN_COUNT,
      scrollDirection: LayoutManager.ScrollDirection.HORIZONTAL,
      onItemLength: function () {
        // Make sure GridViewItem's are square sized
        return ITEM_WIDTH;
      },
    });
    this.initGridView();
  }
}

caution

When new row is inserted on first position, the scroll position is not restored in Android. Due to the reason, we recommend to use below code to restore the scroll position.

if (System.OS === System.OSType.ANDROID) {
  this.myGridView.scrollTo(0);
}

Refresh

onItemSelected: (gridViewItem, index) => {
        this.myGridView.itemCount = this.myDataSet.length;
        this.myDataSet[index].title = 'New Title';
        this.myGridView.refreshRowRange({ positionStart: index, itemCount: 1 });
      },

Delete

onItemSelected: (gridViewItem, index) => {
        this.myDataSet.splice(index, 1);
        this.myGridView.deleteRowRange({ positionStart: index, itemCount: 1 });
        this.myGridView.itemCount = this.myDataSet.length;
      },

---

Pagination

Pagination makes possible displaying the grid records in paged view and can be scrolled on an individual basis.

note

The components in the example are added from the code for better showcase purposes. To learn more about the subject you can refer to:

Adding Component From Code

As a best practice, Smartface recommends using the WYSIWYG editor in order to add components and styles to your page or library. To learn how to use UI Editor better, please refer to this documentation

UI Editor Basics

scripts/pages/pageSample.ts

import PageSampleDesign from "generated/pages/pageSample";
import Color from "@smartface/native/ui/color";
import Label from "@smartface/native/ui/label";
import GridView from "@smartface/native/ui/gridview";
import GridViewItem from "@smartface/native/ui/gridviewitem";
import LayoutManager from "@smartface/native/ui/layoutmanager";
import Application from "@smartface/native/application";
import { Route, Router } from "@smartface/router";
import { styleableComponentMixin } from "@smartface/styling-context";
import { DecelerationRate } from "@smartface/native/ui/gridview/gridview";
import TextAlignment from "@smartface/native/ui/shared/textalignment";
import { IColor } from "@smartface/native/ui/color/color";
import System from "@smartface/native/device/system";
import Screen from "@smartface/native/device/screen";

class StyleableGridView extends styleableComponentMixin(GridView) {}
class StyleableGridViewItem extends styleableComponentMixin(GridViewItem) {}
class StyleableLabel extends styleableComponentMixin(Label) {}

type DatasetType = { title: String; backgroundColor: IColor };
const SPAN_COUNT: number = 1;
const COLORS: string[] = [
  "#ffffff",
  "#e6f7ff",
  "#cceeff",
  "#b3e6ff",
  "#99ddff",
  "#80d4ff",
  "#66ccff",
  "#4dc3ff",
  "#33bbff",
  "#1ab2ff",
  "#00aaff",
  "#0099e6",
  "#0088cc",
  "#0077b3",
  "#006699",
];
const ITEM_WIDTH: number = Screen.width;
//You should create new Page from UI-Editor and extend with it.
export default class PageSample extends PageSampleDesign {
  myGridView: StyleableGridView;
  layoutManager: LayoutManager;
  index: number = 0;
  constructor(private router?: Router, private route?: Route) {
    super({});
  }

  generateDataset(): DatasetType[] {
    let dataset: DatasetType[] = [];
    for (let i = 0; i < 12; ++i) {
      dataset.push({
        title: `Smartface Title ${i}`,
        backgroundColor: Color.create(COLORS[i % COLORS.length]),
      });
    }
    return dataset;
  }

  onShow() {
    super.onShow();
    const { headerBar } =
      System.OS === System.OSType.ANDROID ? this : this.parentController;
    Application.statusBar.visible = false;
    headerBar.visible = false;
  }

  onLoad() {
    super.onLoad();
    let myDataSet: DatasetType[] = this.generateDataset();
    this.layoutManager = new LayoutManager({
      spanCount: SPAN_COUNT,
      scrollDirection: LayoutManager.ScrollDirection.HORIZONTAL,
      onItemLength: function () {
        return ITEM_WIDTH;
      },
    });
    this.layoutManager.ios.targetContentOffset = (
      proposedContentOffset,
      velocity
    ) => {
      let positionX = this.myGridView.contentOffset.x / ITEM_WIDTH;
      let decimalPositionX = positionX;
      let precisionPositionX = positionX % 1;

      if (velocity.x == 0 && precisionPositionX >= 0.5) {
        decimalPositionX = decimalPositionX + 1;
      } else if (velocity.x > 0) {
        decimalPositionX = decimalPositionX + 1;
      }

      return { x: decimalPositionX * ITEM_WIDTH, y: 0 };
    };
    this.myGridView = new StyleableGridView({
      layoutManager: this.layoutManager,
      backgroundColor: Color.TRANSPARENT,
      itemCount: myDataSet.length,
      scrollBarEnabled: false,
      paginationEnabled: true,
      onItemCreate: () => {
        var gridViewItem = new StyleableGridViewItem();
        gridViewItem.paddingLeft = 20;
        var myLabel = new StyleableLabel({
          flexGrow: 1,
          textAlignment: TextAlignment.MIDCENTER,
        });
        gridViewItem.addChild(myLabel);
        this.myGridView.dispatch({
          type: "addChild",
          component: gridViewItem,
          name: `gridViewItem${++this.index}`,
        });
        //@ts-ignore
        gridViewItem.myLabel = myLabel;
        return gridViewItem;
      },
      onItemBind: function (gridViewItem, index) {
        var { title, backgroundColor } =
          myDataSet[myDataSet.length - index - 1];
        //@ts-ignore
        gridViewItem.myLabel.text = title;
        //@ts-ignore
        gridViewItem.myLabel.backgroundColor = backgroundColor;
      },
      onItemSelected: function (gridViewItem, index) {
        //@ts-ignore
        console.log(`Item title : ${gridViewItem.myLabel.text}`);
      },
      onPullRefresh: function () {
        console.log("onPullRefresh");
      },
      onScroll: function (contentOffset) {},
    });
    this.myGridView.refreshEnabled = false;
    this.myGridView.ios.decelerationRate = DecelerationRate.FAST;
    this.layoutManager.contentInset = { top: 0, left: 0, bottom: 0, right: 20 };

    this.addChild(this.myGridView, "myGridView", ".gridView", {
      height: 200,
      marginTop: 150,
    });
    this.style.apply({
      paddingTop: 0,
      paddingLeft: 0,
      paddingBottom: 0,
      paddingRight: 0,
    });
  }
}

Known Issues

• Behavior of the gridview is broken when scrollDirection is set to HORIZONTAL and refreshEnabled is set to true on iOS.