Add Masonry List and Support for OnRefresh (#557)

* Add Masonry List and Support for OnRefresh

* Fix Triggers and Props

* Oops

* Update packages/types/src/component-types.ts

Co-authored-by: Allen Nelson <[email protected]>

* Update packages/types/src/component-types.ts

Co-authored-by: Allen Nelson <[email protected]>

Co-authored-by: Allen Nelson <[email protected]>

Author: bluerssen

packages/core/src/mappings/FlashList.ts

@@ -5,37 +5,89 @@ import {
   createNumberProp,
   CONTAINER_COMPONENT_STYLES_SECTIONS,
   GROUPS,
+  Triggers,
+  createActionProp,
+  createStaticNumberProp,
 } from "@draftbit/types";
 
-export const SEED_DATA = {
-  name: "FlashList",
-  tag: "FlashList",
-  description: "Flashlist by Shopify",
-  packageName: "@shopify/flash-list",
-  category: COMPONENT_TYPES.data,
-  stylesPanelSections: CONTAINER_COMPONENT_STYLES_SECTIONS,
-  layout: {
-    flex: 1,
+export const SEED_DATA = [
+  {
+    name: "Masonry List",
+    tag: "MasonryFlashList",
+    description: "Masonry Flashlist by Shopify",
+    packageName: "@shopify/flash-list",
+    category: COMPONENT_TYPES.data,
+    stylesPanelSections: CONTAINER_COMPONENT_STYLES_SECTIONS,
+    layout: {
+      flex: 1,
+    },
+    triggers: [Triggers.OnRefresh, Triggers.OnEndReached],
+    props: {
+      onRefresh: createActionProp(),
+      onEndReached: createActionProp(),
+      numColumns: createNumColumnsType({
+        editable: true,
+      }),
+      estimatedItemSize: createNumberProp({
+        group: GROUPS.basic,
+        label: "Est. Item Size",
+        description: "Approximate size of the items before rendering.",
+        defaultValue: 50,
+        step: 1,
+        precision: 0,
+      }),
+      optimizeItemArrangement: createStaticBoolProp({
+        label: "Optimize Item Arrangement",
+        description:
+          "If enabled, MasonryFlashList will try to reduce difference in column height by modifying item order. If true, specifying overrideItemLayout is required. Default value is false.",
+      }),
+      onEndReachedThreshold: createStaticNumberProp({
+        label: "End Reached Threshold",
+        description:
+          "How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback. Thus a value of 0.5 will trigger onEndReached when the end of the content is within half the visible length of the list.",
+        defaultValue: 0.5,
+      }),
+    },
   },
-  props: {
-    estimatedItemSize: createNumberProp({
-      group: GROUPS.basic,
-      label: "Est. Item Size",
-      description: "Approximate size of the items before rendering.",
-      defaultValue: 50,
-      step: 1,
-      precision: 0,
-    }),
-    horizontal: createStaticBoolProp({
-      label: "Horizontal",
-      description: "Render list horizontally",
-    }),
-    inverted: createStaticBoolProp({
-      label: "Inverted",
-      description: "If true, reverses the direction.",
-    }),
-    numColumns: createNumColumnsType({
-      editable: true,
-    }),
+  {
+    name: "FlashList",
+    tag: "FlashList",
+    description: "Flashlist by Shopify",
+    packageName: "@shopify/flash-list",
+    category: COMPONENT_TYPES.data,
+    stylesPanelSections: CONTAINER_COMPONENT_STYLES_SECTIONS,
+    layout: {
+      flex: 1,
+    },
+    triggers: [Triggers.OnRefresh, Triggers.OnEndReached],
+    props: {
+      onRefresh: createActionProp(),
+      onEndReached: createActionProp(),
+      estimatedItemSize: createNumberProp({
+        group: GROUPS.basic,
+        label: "Est. Item Size",
+        description: "Approximate size of the items before rendering.",
+        defaultValue: 50,
+        step: 1,
+        precision: 0,
+      }),
+      horizontal: createStaticBoolProp({
+        label: "Horizontal",
+        description: "Render list horizontally",
+      }),
+      inverted: createStaticBoolProp({
+        label: "Inverted",
+        description: "If true, reverses the direction.",
+      }),
+      numColumns: createNumColumnsType({
+        editable: true,
+      }),
+      onEndReachedThreshold: createStaticNumberProp({
+        label: "End Reached Threshold",
+        description:
+          "How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback. Thus a value of 0.5 will trigger onEndReached when the end of the content is within half the visible length of the list.",
+        defaultValue: 0.5,
+      }),
+    },
   },
-};
+];

packages/core/src/mappings/FlatList.ts

@@ -3,6 +3,9 @@ import {
   createNumColumnsType,
   createStaticBoolProp,
   CONTAINER_COMPONENT_STYLES_SECTIONS,
+  Triggers,
+  createActionProp,
+  createStaticNumberProp,
 } from "@draftbit/types";
 
 export const SEED_DATA = {
@@ -14,7 +17,10 @@ export const SEED_DATA = {
   layout: {
     flex: 1,
   },
+  triggers: [Triggers.OnRefresh, Triggers.OnEndReached],
   props: {
+    onRefresh: createActionProp(),
+    onEndReached: createActionProp(),
     horizontal: createStaticBoolProp({
       label: "Horizontal",
       description: "Render list horizontally",
@@ -26,5 +32,15 @@ export const SEED_DATA = {
     numColumns: createNumColumnsType({
       editable: true,
     }),
+    initialNumToRender: createStaticBoolProp({
+      label: "Initial Num To Render",
+      descriprion: "How many items to render in the initial batch",
+    }),
+    onEndReachedThreshold: createStaticNumberProp({
+      label: "End Reached Threshold",
+      description:
+        "How far from the end (in units of visible length of the list) the bottom edge of the list must be from the end of the content to trigger the onEndReached callback. Thus a value of 0.5 will trigger onEndReached when the end of the content is within half the visible length of the list.",
+      defaultValue: 0.5,
+    }),
   },
 };

packages/types/src/component-types.ts

@@ -13,6 +13,7 @@ export const Triggers = {
   OnCheck: "ON_CHECK",
   OnUncheck: "ON_UNCHECK",
   OnPressIcon: "ON_PRESS_ICON",
+  OnEndReached: "ON_END_REACHED",
 };
 
 export const StylesPanelSections = {