@applicaster/zapp-react-native-ui-components 13.0.0-alpha.7222542422 → 13.0.0-alpha.7330390362

package/Components/BaseFocusable/index.ios.ts

@@ -25,7 +25,7 @@ type Props = {
 };
 
 export class BaseFocusable<
-  T extends Props = Props
+  T extends Props = Props,
 > extends BaseFocusableInterface<T> {
   constructor(props) {
     super(props);

package/Components/BaseFocusable/index.tsx

@@ -35,7 +35,7 @@ type Props = {
 };
 
 export class BaseFocusable<
-  T extends Props = Props
+  T extends Props = Props,
 > extends BaseFocusableInterface<T> {
   constructor(props) {
     super(props);

package/Components/Cell/Cell.tsx

@@ -61,7 +61,6 @@ type Props = {
   skipFocusManagerRegistration?: boolean;
   shouldUpdate: boolean;
   behavior: Behavior;
-  componentsMapOffset: number;
 };
 
 type State = {
@@ -274,10 +273,14 @@ export class CellComponent extends React.Component<Props, State> {
             if (isFocused) {
               const accessibilityManager = AccessibilityManager.getInstance();
 
+              const accessibilityTitle =
+                item?.extensions?.accessibility?.label || item?.title || "";
+
+              const accessibilityHint =
+                item?.extensions?.accessibility?.hint || "";
+
               accessibilityManager.readText({
-                text: String(
-                  item.extensions?.accessibility?.label || item.title
-                ),
+                text: `${accessibilityTitle} ${accessibilityHint}`,
               });
             }
 

package/Components/Cell/CellWithFocusable.ios.tsx

@@ -0,0 +1,126 @@
+/** TODO: Remove this file when tvos FocusableGroup
+ * behaviour is aligned to the web one
+ * FocusableGroup should only send onFocus and onBlur events when
+ * Focus enters and leaves the Focusables inside the branch
+ */
+import * as React from "react";
+
+import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
+import * as FOCUS_EVENTS from "@applicaster/zapp-react-native-utils/appUtils/focusManager/events";
+import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
+import { toBooleanWithDefaultFalse } from "@applicaster/zapp-react-native-utils/booleanUtils";
+
+import { isAppleTV } from "../../Helpers/Platform";
+import { useCellState } from "../MasterCell/utils";
+
+const useCellFocusedState = (
+  skipFocusManagerRegistration: boolean,
+  groupId: string,
+  id: string
+) => {
+  const [currentCellFocused, setCurrentCellFocused] = React.useState(false);
+
+  React.useEffect(() => {
+    const isGroupItemFocused = () => {
+      if (!skipFocusManagerRegistration) {
+        const isFocused = focusManager.isGroupItemFocused(groupId, id);
+        setCurrentCellFocused(isFocused);
+      }
+    };
+
+    const handler = () => {
+      // tvOS hack for properly checking focus
+      if (isAppleTV()) {
+        setTimeout(() => {
+          isGroupItemFocused();
+        }, 0);
+      } else {
+        isGroupItemFocused();
+      }
+    };
+
+    focusManager.on(FOCUS_EVENTS.FOCUS, handler);
+
+    return () => {
+      focusManager.removeHandler(FOCUS_EVENTS.FOCUS, handler);
+    };
+  }, [groupId, skipFocusManagerRegistration]);
+
+  return currentCellFocused;
+};
+
+type Props = {
+  item: ZappEntry;
+  CellRenderer: React.FunctionComponent<any>;
+  id: string;
+  groupId: string;
+  onFocus: Function;
+  index: number;
+  scrollTo: Function;
+  preferredFocus?: boolean;
+  skipFocusManagerRegistration?: boolean;
+  isFocusable?: boolean;
+  behavior: Behavior;
+  focused?: boolean;
+};
+
+export function CellWithFocusable(props: Props) {
+  const {
+    index,
+    item,
+    CellRenderer,
+    id,
+    groupId,
+    onFocus,
+    scrollTo = noop,
+    preferredFocus,
+    skipFocusManagerRegistration,
+    isFocusable,
+    behavior,
+    focused,
+  } = props;
+
+  const isFocused = useCellFocusedState(
+    skipFocusManagerRegistration,
+    groupId,
+    id
+  );
+
+  const state = useCellState({
+    id: item.id,
+    behavior,
+    focused: isFocused || toBooleanWithDefaultFalse(focused),
+  });
+
+  const [focusedButtonId, setFocusedButtonId] = React.useState(undefined);
+
+  // for horizontal scrolling
+  React.useEffect(() => {
+    if (focusedButtonId) {
+      scrollTo(index);
+    }
+  }, [focusedButtonId]);
+
+  const handleToggleFocus = (value) => {
+    setFocusedButtonId(value.focusedButtonId);
+
+    if (value.focusable) {
+      onFocus(value.focusable, value.mouse);
+    }
+  };
+
+  return (
+    <CellRenderer
+      item={item}
+      groupId={groupId}
+      onToggleFocus={handleToggleFocus}
+      state={state}
+      prefixId={id}
+      focusedButtonId={focusedButtonId}
+      preferredFocus={preferredFocus}
+      skipFocusManagerRegistration={skipFocusManagerRegistration}
+      isFocusable={isFocusable}
+      focused={focused}
+    />
+  );
+}

package/Components/Cell/CellWithFocusable.tsx

@@ -1,48 +1,10 @@
 import * as React from "react";
 
-import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
-import * as FOCUS_EVENTS from "@applicaster/zapp-react-native-utils/appUtils/focusManager/events";
 import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
 import { toBooleanWithDefaultFalse } from "@applicaster/zapp-react-native-utils/booleanUtils";
 
-import { isAppleTV } from "../../Helpers/Platform";
 import { useCellState } from "../MasterCell/utils";
-
-const useCellFocusedState = (
-  skipFocusManagerRegistration: boolean,
-  groupId: string,
-  id: string
-) => {
-  const [currentCellFocused, setCurrentCellFocused] = React.useState(false);
-
-  React.useEffect(() => {
-    const isGroupItemFocused = () => {
-      if (!skipFocusManagerRegistration) {
-        const isFocused = focusManager.isGroupItemFocused(groupId, id);
-        setCurrentCellFocused(isFocused);
-      }
-    };
-
-    const handler = () => {
-      // tvOS hack for properly checking focus
-      if (isAppleTV()) {
-        setTimeout(() => {
-          isGroupItemFocused();
-        }, 0);
-      } else {
-        isGroupItemFocused();
-      }
-    };
-
-    focusManager.on(FOCUS_EVENTS.FOCUS, handler);
-
-    return () => {
-      focusManager.removeHandler(FOCUS_EVENTS.FOCUS, handler);
-    };
-  }, [groupId, skipFocusManagerRegistration]);
-
-  return currentCellFocused;
-};
+import { FocusableGroup } from "../FocusableGroup";
 
 type Props = {
   item: ZappEntry;
@@ -75,11 +37,7 @@ export function CellWithFocusable(props: Props) {
     focused,
   } = props;
 
-  const isFocused = useCellFocusedState(
-    skipFocusManagerRegistration,
-    groupId,
-    id
-  );
+  const [isFocused, setIsFocused] = React.useState(false);
 
   const state = useCellState({
     id: item.id,
@@ -96,26 +54,52 @@ export function CellWithFocusable(props: Props) {
     }
   }, [focusedButtonId]);
 
-  const handleToggleFocus = (value) => {
-    setFocusedButtonId(value.focusedButtonId);
+  const handleToggleFocus = React.useCallback(
+    (value) => {
+      setFocusedButtonId(value.focusedButtonId);
+
+      if (value.focusable) {
+        onFocus(value.focusable, value.mouse);
+      }
+    },
+    [onFocus]
+  );
+
+  const onGroupFocus = React.useCallback(() => {
+    if (!skipFocusManagerRegistration) {
+      setIsFocused(true);
+    }
+  }, [skipFocusManagerRegistration]);
 
-    if (value.focusable) {
-      onFocus(value.focusable, value.mouse);
+  const onGroupBlur = React.useCallback(() => {
+    if (!skipFocusManagerRegistration) {
+      setIsFocused(false);
     }
-  };
+  }, [skipFocusManagerRegistration]);
 
   return (
-    <CellRenderer
-      item={item}
+    <FocusableGroup
+      id={`focusable-cell-wrapper-${id}`}
+      testID={"cell-with-focusable-cell-renderer-focusable-group"}
       groupId={groupId}
-      onToggleFocus={handleToggleFocus}
-      state={state}
-      prefixId={id}
-      focusedButtonId={focusedButtonId}
       preferredFocus={preferredFocus}
-      skipFocusManagerRegistration={skipFocusManagerRegistration}
-      isFocusable={isFocusable}
-      focused={focused}
-    />
+      shouldUsePreferredFocus
+      onFocus={onGroupFocus}
+      onBlur={onGroupBlur}
+    >
+      <CellRenderer
+        testID={"cell-with-focusable-cell-renderer"}
+        item={item}
+        groupId={`focusable-cell-wrapper-${id}`}
+        onToggleFocus={handleToggleFocus}
+        state={state}
+        prefixId={id}
+        focusedButtonId={focusedButtonId}
+        preferredFocus={true}
+        skipFocusManagerRegistration={skipFocusManagerRegistration}
+        isFocusable={isFocusable}
+        focused={focused}
+      />
+    </FocusableGroup>
   );
 }

package/Components/Cell/TvOSCellComponent.tsx

@@ -2,7 +2,7 @@ import * as React from "react";
 import * as R from "ramda";
 import { View, StyleSheet } from "react-native";
 
-import { Focusable } from "@applicaster/zapp-react-native-ui-components/Components/Focusable/FocusableTvOS";
+import { Focusable } from "@applicaster/zapp-react-native-ui-components/Components/Focusable";
 import { FocusableCell } from "@applicaster/zapp-react-native-ui-components/Components/FocusableCell";
 import { getItemType } from "@applicaster/zapp-react-native-utils/navigationUtils";
 import { SCREEN_TYPES } from "@applicaster/zapp-react-native-utils/navigationUtils/itemTypes";
@@ -65,7 +65,6 @@ type Props = {
   isFocusable: boolean;
   shouldUpdate: boolean;
   behavior: Behavior;
-  componentsMapOffset: number;
 };
 
 type State = {
@@ -180,7 +179,6 @@ export class TvOSCellComponent extends React.Component<Props, State> {
       groupId,
       component,
       index,
-      componentsMapOffset,
     } = this.props;
 
     this.setScreenLayout(componentAnchorPointY, screenLayout);
@@ -195,11 +193,13 @@ export class TvOSCellComponent extends React.Component<Props, State> {
       const extraAnchorPointYOffset =
         screenLayout?.extraAnchorPointYOffset || 0;
 
+      const marginTop = screenLayout?.screenMarginTop || 0;
+
       const totalOffset =
         headerOffset +
-          (componentAnchorPointY || 0) +
-          extraAnchorPointYOffset -
-          componentsMapOffset || 0;
+        (componentAnchorPointY || 0) +
+        extraAnchorPointYOffset -
+        marginTop;
 
       mainOffsetUpdater?.(
         { tag: this.target },
@@ -247,7 +247,7 @@ export class TvOSCellComponent extends React.Component<Props, State> {
 
     const focusableId = R.join("-", [component?.id, id, index]);
 
-    const handleFocus = (arg1: any, index?: number) => {
+    const handleFocus = (arg1: any, index: number) => {
       const focusFn = onFocus || noop;
       focusFn(arg1, index);
 
@@ -280,7 +280,7 @@ export class TvOSCellComponent extends React.Component<Props, State> {
       <View onLayout={this.onLayout} style={styles.container}>
         <Focusable
           id={focusableId}
-          groupId={String(groupId || component?.id)}
+          groupId={groupId || component?.id}
           onFocus={handleFocus}
           onBlur={onBlur || this.onBlur}
           isParallaxDisabled={this.layout?.width > 1740}
@@ -292,18 +292,20 @@ export class TvOSCellComponent extends React.Component<Props, State> {
           style={baseCellStyles}
           isFocusable={isFocusable}
         >
-          {(focused) => (
-            <FocusableCell
-              {...{
-                index,
-                CellRenderer,
-                item,
-                focused: !!(this.props.focused || selectedCell || focused),
-                scrollTo: this.scrollTo,
-                behavior,
-              }}
-            />
-          )}
+          {(focused) => {
+            return (
+              <FocusableCell
+                {...{
+                  index,
+                  CellRenderer,
+                  item,
+                  focused: this.props.focused || selectedCell || focused,
+                  scrollTo: this.scrollTo,
+                  behavior,
+                }}
+              />
+            );
+          }}
         </Focusable>
       </View>
     );

package/Components/Cell/__tests__/CellWIthFocusable.test.js

@@ -1,7 +1,7 @@
 import { View } from "react-native";
 import React from "react";
 import { act, render } from "@testing-library/react-native";
-import { CellWithFocusable } from "../CellWithFocusable";
+import { CellWithFocusable } from "../CellWithFocusable.tsx";
 
 import { focusManager } from "@applicaster/zapp-react-native-utils/appUtils/focusManager";
 
@@ -23,7 +23,9 @@ describe("CellWithFocusable", () => {
 
     const wrapper = renderWith(props);
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("default");
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
+
+    expect(element.props.state).toBe("default");
   });
 
   it("should render in default state", () => {
@@ -40,8 +42,9 @@ describe("CellWithFocusable", () => {
     focusManager.isGroupItemFocused = jest.fn(() => true);
 
     const wrapper = renderWith(props);
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("default");
+    expect(element.props.state).toBe("default");
   });
 
   it("should render in focused state", () => {
@@ -55,13 +58,17 @@ describe("CellWithFocusable", () => {
       scrollTo: jest.fn(),
     };
 
-    focusManager.isGroupItemFocused = jest.fn(() => true);
     const wrapper = renderWith(props);
 
+    const focusableGroupComponent = wrapper.getByTestId(
+      "cell-with-focusable-cell-renderer-focusable-group"
+    );
+
     act(() => {
-      focusManager.on.mock.calls[focusManager.on.mock.calls.length - 1][1]();
+      focusableGroupComponent.props.onFocus();
     });
 
-    expect(wrapper.UNSAFE_getByType("View").props.state).toBe("focused");
+    const element = wrapper.getByTestId("cell-with-focusable-cell-renderer");
+    expect(element.props.state).toBe("focused");
   });
 });

package/Components/Cell/index.js

@@ -11,7 +11,6 @@ import { ScreenScrollingContext } from "../../Contexts/ScreenScrollingContext";
 
 import { ScreenLayoutContextConsumer } from "../../Contexts/ScreenLayoutContext";
 import { createContext } from "@applicaster/zapp-react-native-utils/reactUtils/createContext";
-import { withComponentsMapOffsetContextConsumer } from "../../Contexts/ComponentsMapOffsetContext";
 
 // TODO | Gallery QB | Extract this
 export const ScrollInterceptorContext = createContext(
@@ -31,6 +30,5 @@ export const Cell = R.compose(
   RiverOffsetContext.withConsumer,
   HorizontalScrollContext.withConsumer,
   withConsumer,
-  ScreenLayoutContextConsumer,
-  withComponentsMapOffsetContextConsumer
+  ScreenLayoutContextConsumer
 )(Component);

package/Components/Focusable/FocusableTvOS.tsx

@@ -9,7 +9,7 @@ import {
   focusManager,
   forceFocusableFocus,
 } from "@applicaster/zapp-react-native-utils/appUtils/focusManager/index.ios";
-import { findNodeHandle, ViewStyle } from "react-native";
+import { findNodeHandle } from "react-native";
 
 function noop() {}
 
@@ -35,10 +35,6 @@ type Props = {
   forceFocus?: boolean;
   initialFocus?: boolean;
   onLayout?: (e: any) => void;
-  willReceiveFocus: () => void;
-  hasReceivedFocus: () => void;
-  offsetUpdater: (arg1: string, arg2: number) => number;
-  style: ViewStyle;
 };
 
 export class Focusable extends BaseFocusable<Props> {

package/Components/Focusable/Touchable.tsx

@@ -1,25 +1,24 @@
 import * as React from "react";
 
-type Props =
-  | {
-      id: string;
-      children: React.ReactNode;
-      onPress?: (ref: FocusManager.TouchableRef) => void;
-      onPressIn?: (ref: FocusManager.TouchableRef) => void;
-      onPressOut?: (ref: FocusManager.TouchableRef) => void;
-      onLongPress?: (ref: FocusManager.TouchableRef) => void;
-      onFocus?: (
-        ref: FocusManager.TouchableRef,
-        options: FocusManager.Android.CallbackOptions
-      ) => void;
-      onBlur?: (
-        ref: FocusManager.TouchableRef,
-        options: FocusManager.Android.CallbackOptions
-      ) => void;
-
-      disableFocus?: boolean;
-      blockFocus?: boolean;
-    } & Partial<ParentFocus>;
+type Props = {
+  id: string;
+  children: React.ReactNode;
+  onPress?: (ref: FocusManager.TouchableRef) => void;
+  onPressIn?: (ref: FocusManager.TouchableRef) => void;
+  onPressOut?: (ref: FocusManager.TouchableRef) => void;
+  onLongPress?: (ref: FocusManager.TouchableRef) => void;
+  onFocus?: (
+    ref: FocusManager.TouchableRef,
+    options: FocusManager.Android.CallbackOptions
+  ) => void;
+  onBlur?: (
+    ref: FocusManager.TouchableRef,
+    options: FocusManager.Android.CallbackOptions
+  ) => void;
+
+  disableFocus?: boolean;
+  blockFocus?: boolean;
+} & Partial<ParentFocus>;
 
 export class Touchable extends React.Component<Props> {
   onPress(focusableRef: FocusManager.TouchableRef): void {

package/Components/FocusableList/index.tsx

@@ -15,7 +15,6 @@ import { noop } from "@applicaster/zapp-react-native-utils/functionUtils";
 
 import { useParentFocus, useCheckItemIdsForUnique } from "./hooks";
 import { FocusableListItemWrapper } from "./FocusableListItemWrapper";
-import { FocusableScrollView } from "../FocusableScrollView";
 
 const mapIndexed = R.addIndex(R.map);
 
@@ -55,7 +54,6 @@ export type Props<ItemT> = FlatListProps<ItemT> & {
   disableNextFocusUp?: boolean;
   disableNextFocusLeft?: boolean;
   disableNextFocusRight?: boolean;
-  useScrollView?: boolean;
 } & ParentFocus;
 
 function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
@@ -90,7 +88,6 @@ function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
     data = [],
     // eslint-disable-next-line unused-imports/no-unused-vars
     omitPropsPropagation = [],
-    useScrollView = false,
   } = props;
 
   useCheckItemIdsForUnique({ componentId: props.id, items: data });
@@ -276,7 +273,6 @@ function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
         "initialFocusDirection",
         "withStateMemory",
         "useSequentialLoading",
-        "useScrollView",
         ...omitPropsPropagation,
       ],
       R.__
@@ -299,27 +295,15 @@ function FocusableListComponent<ItemT>(props: Props<ItemT>, ref) {
   return (
     // @ts-ignore
     <ChildrenFocusDeactivatorView flex={1}>
-      {useScrollView ? (
-        <FocusableScrollView
-          ref={ref}
-          {...getFlatListProps(props)}
-          onEndReached={onEndReached}
-          initialNumToRender={initialNumToRender}
-          renderItem={renderItem}
-          focused={focused}
-          data={data}
-        />
-      ) : (
-        <FlatList
-          focusable={false}
-          scrollEnabled={false}
-          ref={ref}
-          {...getFlatListProps(props)}
-          renderItem={renderItem}
-          onEndReached={onEndReached}
-          initialNumToRender={initialNumToRender}
-        />
-      )}
+      <FlatList
+        focusable={false}
+        scrollEnabled={false}
+        ref={ref}
+        {...getFlatListProps(props)}
+        renderItem={renderItem}
+        onEndReached={onEndReached}
+        initialNumToRender={initialNumToRender}
+      />
     </ChildrenFocusDeactivatorView>
   );
 }

package/Components/FocusableScrollView/index.tsx

@@ -11,13 +11,6 @@ import {
   useInitialFocus,
 } from "@applicaster/zapp-react-native-utils/focusManager";
 
-export type FocusableScrollViewRenderItem = (info: {
-  item: ZappUIComponent;
-  index: number;
-  focused: boolean;
-  parentFocus: ParentFocus;
-}) => React.ReactElement;
-
 export type Props = ScrollViewProps & {
   id?: number | string;
   horizontal?: boolean;
@@ -39,27 +32,17 @@ export type Props = ScrollViewProps & {
   initialFocusDirection?: FocusManager.Android.FocusNavigationDirections;
   onAllComponentsLoaded?: () => void;
   omitPropsPropagation?: Array<keyof FlatListProps<any>>;
-  renderItem: FocusableScrollViewRenderItem;
+  renderItem: (info: {
+    item: ZappUIComponent;
+    index: number;
+    focused: boolean;
+    parentFocus: ParentFocus;
+  }) => React.ReactElement;
 } & ParentFocus;
 
 type State = boolean[];
 type Action = { index?: number; isFocusable: boolean; type?: string };
 
-const unwrapArray = (maybeArray) =>
-  Array.isArray(maybeArray) ? maybeArray[0] : maybeArray;
-
-function getEntry<T>(data: T | T[], index: unknown): T {
-  let entry;
-
-  if (R.isNil(index)) {
-    entry = unwrapArray(data);
-  } else if (typeof index === "number") {
-    entry = unwrapArray(data[index]);
-  }
-
-  return entry;
-}
-
 const focusableStateReducer = (
   state: State,
   { index = null, isFocusable, type = null }: Action
@@ -90,7 +73,7 @@ const extendScrollViewRef = (_ref, childCompsMeasurementsMap) => {
   };
 
   _ref.scrollToIndex = (params) => {
-    const { index, viewOffset = 0 } = params;
+    const { index, viewOffset } = params;
 
     const itemByIndex = R.find(R.propEq("index", index))(
       R.values(childCompsMeasurementsMap)
@@ -146,11 +129,8 @@ function FocusableScrollViewComponent(props: Props, ref) {
   );
 
   const getFocusableEntryId = React.useCallback(
-    (_entry: ZappEntry | null, index?: number) => {
-      const entry: { id?: string } = getEntry(
-        R.isNil(index) ? _entry : data,
-        index
-      );
+    (_entry: ZappEntry, index?: number) => {
+      const entry = R.isNil(index) ? _entry : data[index];
 
       return entry ? `${props.id}--${entry?.id}` : undefined;
     },
@@ -293,18 +273,11 @@ function FocusableScrollViewComponent(props: Props, ref) {
   const renderItem = React.useCallback(
     (item, index) => {
       const renderArgs = { item, index };
-
-      const id = getFocusableEntryId(
-        Array.isArray(item) ? item[0] : item,
-        index
-      );
-
-      const nextFocus = getNextFocus(index);
+      const id = `${props.id}--${renderArgs?.item?.id}`;
+      const nextFocus = getNextFocus(renderArgs?.index);
 
       const onItemLayout = (event) => {
-        childCompsMeasurementsMap.current[
-          Array.isArray(item) ? index : item.id
-        ] = {
+        childCompsMeasurementsMap.current[item.id] = {
           index,
           layout: event.nativeEvent.layout,
         };