@hero-design/rn 8.41.0 → 8.41.1

package/src/components/Success/__tests__/index.spec.tsx

@@ -3,6 +3,7 @@ import { fireEvent } from '@testing-library/react-native';
 import renderWithTheme from '../../../testHelpers/renderWithTheme';
 import Success from '..';
 import Image from '../../Image';
+import Portal from '../../Portal';
 
 const title = `We’re sorry, something went wrong`;
 const description = 'Please try again later';
@@ -46,12 +47,14 @@ describe('Success', () => {
   });
   it('renders full screen success page correctly', () => {
     const { toJSON, getByText, getByTestId } = renderWithTheme(
-      <Success
-        variant="full-screen"
-        title={title}
-        description={description}
-        image="path_to_image"
-      />
+      <Portal.Provider>
+        <Success
+          variant="full-screen"
+          title={title}
+          description={description}
+          image="path_to_image"
+        />
+      </Portal.Provider>
     );
 
     expect(getByText(title)).toBeTruthy();

package/src/index.ts

@@ -38,7 +38,6 @@ import HeroDesignProvider from './components/HeroDesignProvider';
 import Icon from './components/Icon';
 import Image from './components/Image';
 import List from './components/List';
-import Modal from './components/Modal';
 import PinInput from './components/PinInput';
 import Progress from './components/Progress';
 import Slider from './components/Slider';
@@ -103,7 +102,6 @@ export {
   Image,
   HeroDesignProvider,
   List,
-  Modal,
   PinInput,
   Progress,
   Portal,

package/testUtils/setup.tsx

@@ -132,22 +132,4 @@ jest.mock('react-native/Libraries/Utilities/BackHandler', () => {
   );
 });
 
-jest.mock('react-native-root-siblings', () => {
-  const React = jest.requireActual('react');
-
-  class RootSiblingsManager extends React.Component {
-    constructor(props) {
-      super(props);
-    }
-    render() {
-      return React.createElement('RootSiblingsManager', this.props, this.props.children);
-    }
-  }
-
-  return {
-    __esModule: true,
-    default: RootSiblingsManager,
-  };
-});
-
 export {};

package/types/components/Error/StyledError.d.ts

@@ -1,12 +1,10 @@
 /// <reference types="react" />
-import { Modal, View } from 'react-native';
+import { View } from 'react-native';
 type ErrorVariant = 'full-screen' | 'in-page';
-declare const StyledErrorModal: import("@emotion/native").StyledComponent<import("react-native").ModalBaseProps & import("react-native").ModalPropsIOS & import("react-native").ModalPropsAndroid & import("react-native").ViewProps & {
+declare const StyledErrorModal: import("@emotion/native").StyledComponent<import("../Modal").ModalProps & {
     theme?: import("@emotion/react").Theme | undefined;
     as?: import("react").ElementType<any> | undefined;
-}, {}, {
-    ref?: import("react").Ref<Modal> | undefined;
-}>;
+}, {}, {}>;
 declare const StyledErrorContainer: import("@emotion/native").StyledComponent<import("react-native").ViewProps & {
     theme?: import("@emotion/react").Theme | undefined;
     as?: import("react").ElementType<any> | undefined;

package/types/components/Modal/index.d.ts

@@ -1,9 +1,9 @@
-import React from 'react';
+import { ReactNode } from 'react';
 export interface ModalProps {
     /**
      * Content of the modal.
      */
-    children: React.ReactElement;
+    children: ReactNode;
     /**
      * Visibility of the modal
      */
@@ -24,10 +24,14 @@ export interface ModalProps {
      * Animation type of the modal content.
      */
     animationType?: 'none' | 'slide' | 'fade';
+    /**
+     * Whether to show the modal backdrop
+     */
+    transparent?: boolean;
+    /**
+     * Callback when the modal is dismissed. iOS only.
+     */
+    onDismiss?: () => void;
 }
-declare const _default: (({ children, onShow, onRequestClose, testID, visible, animationType, }: ModalProps) => null) & {
-    Provider: ({ children }: {
-        children: React.ReactNode;
-    }) => JSX.Element;
-};
-export default _default;
+declare const ModalWrapper: ({ visible, ...props }: ModalProps) => JSX.Element | null;
+export default ModalWrapper;

package/types/components/Portal/index.d.ts

@@ -1,13 +1,18 @@
-import { ReactNode } from 'react';
+import React, { ReactNode } from 'react';
+import { Theme } from '../../theme';
 export interface PortalProps {
     name?: string;
     hostName?: string;
     children?: ReactNode | ReactNode[];
+    /**
+     * Theme for portal children.
+     */
+    theme?: Theme;
 }
-declare const _default: import("react").NamedExoticComponent<PortalProps> & {
-    readonly type: ({ name, hostName, children }: PortalProps) => null;
+declare const _default: React.NamedExoticComponent<PortalProps> & {
+    readonly type: ({ name, hostName, children, theme }: PortalProps) => null;
 } & {
-    Provider: import("react").MemoExoticComponent<({ rootHostName, children, }: import("./PortalProvider").PortalProviderProps) => JSX.Element>;
-    Host: import("react").MemoExoticComponent<({ name }: import("./PortalHost").PortalHostProps) => JSX.Element>;
+    Provider: React.MemoExoticComponent<({ rootHostName, children, }: import("./PortalProvider").PortalProviderProps) => JSX.Element>;
+    Host: React.MemoExoticComponent<({ name }: import("./PortalHost").PortalHostProps) => JSX.Element>;
 };
 export default _default;

package/types/components/Success/StyledSuccess.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="react" />
-import { Modal, View } from 'react-native';
+import { View } from 'react-native';
 type SuccessVariant = 'full-screen' | 'in-page';
 declare const StyledSuccessContainer: import("@emotion/native").StyledComponent<import("react-native").ViewProps & {
     theme?: import("@emotion/react").Theme | undefined;
@@ -45,10 +45,8 @@ declare const StyledSuccessButtonPrimary: import("@emotion/native").StyledCompon
     theme?: import("@emotion/react").Theme | undefined;
     as?: import("react").ElementType<any> | undefined;
 }, {}, {}>;
-declare const StyledSuccessModal: import("@emotion/native").StyledComponent<import("react-native").ModalBaseProps & import("react-native").ModalPropsIOS & import("react-native").ModalPropsAndroid & import("react-native").ViewProps & {
+declare const StyledSuccessModal: import("@emotion/native").StyledComponent<import("../Modal").ModalProps & {
     theme?: import("@emotion/react").Theme | undefined;
     as?: import("react").ElementType<any> | undefined;
-}, {}, {
-    ref?: import("react").Ref<Modal> | undefined;
-}>;
+}, {}, {}>;
 export { SuccessVariant, StyledSuccessImage, StyledSuccessContainer, StyledSuccessContent, StyledSuccessImageContainer, StyledSuccessTitle, StyledSuccessDescription, StyledSuccessButtonContainer, StyledSuccessButtonPrimary, StyledSuccessModal, };

package/types/index.d.ts

@@ -25,7 +25,6 @@ import HeroDesignProvider from './components/HeroDesignProvider';
 import Icon from './components/Icon';
 import Image from './components/Image';
 import List from './components/List';
-import Modal from './components/Modal';
 import PinInput from './components/PinInput';
 import Progress from './components/Progress';
 import Slider from './components/Slider';
@@ -49,5 +48,5 @@ import RefreshControl from './components/RefreshControl';
 import RichTextEditor from './components/RichTextEditor';
 import PageControl from './components/PageControl';
 import Portal from './components/Portal';
-export { theme, getTheme, useTheme, scale, ThemeProvider, ThemeSwitcher, withTheme, swagSystemPalette, swagDarkSystemPalette, workSystemPalette, jobsSystemPalette, walletSystemPalette, eBensSystemPalette, Accordion, Alert, Attachment, Avatar, useAvatarColors, Badge, BottomNavigation, BottomSheet, Box, Button, Calendar, Card, Carousel, Collapse, Checkbox, ContentNavigator, DatePicker, Divider, Drawer, Empty, Error, FAB, Icon, Image, HeroDesignProvider, List, Modal, PinInput, Progress, Portal, PageControl, Skeleton, Slider, Spinner, Swipeable, Radio, SectionHeading, Select, Success, Switch, Tabs, Tag, TextInput, TimePicker, Toast, Toolbar, Typography, Rate, RefreshControl, RichTextEditor, };
+export { theme, getTheme, useTheme, scale, ThemeProvider, ThemeSwitcher, withTheme, swagSystemPalette, swagDarkSystemPalette, workSystemPalette, jobsSystemPalette, walletSystemPalette, eBensSystemPalette, Accordion, Alert, Attachment, Avatar, useAvatarColors, Badge, BottomNavigation, BottomSheet, Box, Button, Calendar, Card, Carousel, Collapse, Checkbox, ContentNavigator, DatePicker, Divider, Drawer, Empty, Error, FAB, Icon, Image, HeroDesignProvider, List, PinInput, Progress, Portal, PageControl, Skeleton, Slider, Spinner, Swipeable, Radio, SectionHeading, Select, Success, Switch, Tabs, Tag, TextInput, TimePicker, Toast, Toolbar, Typography, Rate, RefreshControl, RichTextEditor, };
 export * from './types';

package/src/components/Modal/ModalContentWrapper.tsx

@@ -1,112 +0,0 @@
-import React, { forwardRef } from 'react';
-import {
-  Animated,
-  Dimensions,
-  Easing,
-  Platform,
-  StyleProp,
-  ViewStyle,
-} from 'react-native';
-
-type ModalContentWrapperProps = {
-  children: React.ReactElement;
-  visible?: boolean;
-  onShow?: () => void;
-  testID?: string;
-  animationType?: 'none' | 'slide' | 'fade';
-  style?: StyleProp<ViewStyle>;
-  animated?: boolean;
-};
-
-export type ModalContentWrapperHandler = {
-  hide: (callback?: () => void) => void;
-};
-
-const windowHeight = Dimensions.get('window').height;
-const defaultAnimationConfig = {
-  easing: Easing.inOut(Easing.cubic),
-  duration: 400,
-  useNativeDriver: Platform.OS !== 'web',
-};
-
-const ModalContentWrapper = forwardRef<
-  ModalContentWrapperHandler,
-  ModalContentWrapperProps
->(
-  (
-    {
-      animationType,
-      children,
-      testID,
-      onShow,
-      style,
-      visible,
-      animated = true,
-    },
-    ref
-  ) => {
-    const animatedValue = React.useRef(new Animated.Value(0)).current;
-
-    const modalAnimation = animatedValue.interpolate(
-      animationType === 'fade'
-        ? {
-            inputRange: [0, 1],
-            outputRange: [0, 1],
-          }
-        : {
-            inputRange: [0, 1],
-            outputRange: [windowHeight, 0],
-          }
-    );
-
-    React.useImperativeHandle(
-      ref,
-      () => ({
-        hide: (callback) => {
-          Animated.timing(animatedValue, {
-            toValue: 0,
-            ...defaultAnimationConfig,
-          }).start(callback);
-        },
-      }),
-      [animatedValue]
-    );
-
-    React.useEffect(() => {
-      // Hiding animation will be called from the modal component
-      if (visible) {
-        Animated.timing(animatedValue, {
-          toValue: 1,
-          ...defaultAnimationConfig,
-          // Prevent animation when updating the modal content
-          duration: animated ? defaultAnimationConfig.duration : 0,
-        }).start(() => {
-          onShow?.();
-        });
-      }
-    }, [visible, animatedValue, onShow, animated]);
-
-    return (
-      <Animated.View
-        testID={testID}
-        style={[
-          style,
-          {
-            ...(animationType === 'fade' ? { opacity: modalAnimation } : {}),
-            ...(animationType === 'slide'
-              ? {
-                  transform: [{ translateY: modalAnimation }],
-                }
-              : {}),
-          },
-        ]}
-      >
-        {children}
-      </Animated.View>
-    );
-  }
-);
-
-ModalContentWrapper.displayName = 'ModalContentWrapper';
-
-export default ModalContentWrapper;

package/src/components/Modal/ModalPresenter/ModalPresenter.tsx

@@ -1,135 +0,0 @@
-import React, { forwardRef, useRef } from 'react';
-import { Animated, StyleSheet, ViewProps } from 'react-native';
-import RootSiblings from 'react-native-root-siblings';
-import { useTheme } from '../../../theme';
-import Box from '../../Box';
-
-export type ModalPresenterHandles = {
-  animatedOut: (completion?: () => void) => void;
-};
-export type ModalDismissFunc = (onDismiss?: () => void) => void;
-export type ModalUpdateFunc = (content: React.ReactNode) => void;
-
-/**
- * Modal handler is returned by `showModal` function.
- */
-export type ModalHandler = {
-  /**
-   * Same `dismiss` function as in `ModalContentProps`.
-   */
-  dismiss: ModalDismissFunc;
-  /**
-   * Same `update` function as in `ModalContentProps`.
-   */
-  update: ModalUpdateFunc;
-};
-
-const ModalPresenter = forwardRef<ModalPresenterHandles, ViewProps>(
-  ({ style, children, ...props }, ref) => {
-    const animatedOpacity = useRef(new Animated.Value(0));
-    const theme = useTheme();
-
-    React.useEffect(() => {
-      Animated.spring(animatedOpacity.current, {
-        toValue: 1,
-        useNativeDriver: true,
-      }).start();
-    }, []);
-
-    React.useImperativeHandle(ref, () => ({
-      animatedOut: (completion?: () => void) => {
-        Animated.spring(animatedOpacity.current, {
-          toValue: 0,
-          useNativeDriver: true,
-        }).start(() => {
-          completion?.();
-        });
-      },
-    }));
-
-    return (
-      <Box style={StyleSheet.absoluteFill}>
-        <Animated.View
-          style={[
-            {
-              width: '100%',
-              height: '100%',
-              backgroundColor: `${theme.colors.overlayGlobalSurface}66`, // 66 = 40% opacity as suggested by the mobile color guidelines
-              justifyContent: 'center',
-              alignItems: 'center',
-              opacity: animatedOpacity.current,
-            },
-            style,
-          ]}
-          {...props}
-        >
-          {children}
-        </Animated.View>
-      </Box>
-    );
-  }
-);
-
-/**
- * Present a modal on screen immediately.
- *
- * The new presented modal will be on top of existing modals if there are any.
- *
- * @param Content A component to be presented as a modal on screen.
- * This component will be centered horizontally and vertically on screen with
- * a semitransparent black overlay underneath.
- * @param contentProps Props for this modal component.
- * @returns A `ModalHandler` you can use to dismiss the modal.
- */
-
-export const showModal = (content: React.ReactNode): ModalHandler => {
-  let ref: ModalPresenterHandles | null = null;
-  let rootSiblings: RootSiblings | null = null;
-
-  const dismiss: ModalDismissFunc = (onDismiss) => {
-    if (rootSiblings) {
-      const cleanup = () => {
-        rootSiblings?.destroy();
-        rootSiblings = null;
-        ref = null;
-        onDismiss?.();
-      };
-
-      if (ref) {
-        ref.animatedOut(cleanup);
-      } else {
-        cleanup();
-      }
-    }
-  };
-
-  const update: ModalUpdateFunc = (newContent) => {
-    rootSiblings?.update(
-      <ModalPresenter
-        ref={(_ref) => {
-          ref = _ref;
-        }}
-      >
-        {newContent}
-      </ModalPresenter>
-    );
-  };
-
-  rootSiblings = new RootSiblings(
-    (
-      <ModalPresenter
-        ref={(_ref) => {
-          ref = _ref;
-        }}
-      >
-        {content}
-      </ModalPresenter>
-    )
-  );
-
-  return { dismiss, update };
-};
-
-ModalPresenter.displayName = 'ModalPresenter';
-
-export default ModalPresenter;

package/src/components/Modal/ModalPresenter/index.tsx

@@ -1,9 +0,0 @@
-import {
-  ModalDismissFunc,
-  ModalHandler,
-  showModal,
-  ModalPresenterHandles,
-} from './ModalPresenter';
-
-export type { ModalDismissFunc, ModalHandler, ModalPresenterHandles };
-export { showModal };

package/src/components/Modal/ModalProvider.tsx

@@ -1,8 +0,0 @@
-import React, { ReactNode } from 'react';
-import { RootSiblingParent } from 'react-native-root-siblings';
-
-const ModalProvider = ({ children }: { children: ReactNode }) => {
-  return <RootSiblingParent>{children}</RootSiblingParent>;
-};
-
-export default ModalProvider;

package/types/components/Modal/ModalContentWrapper.d.ts

@@ -1,16 +0,0 @@
-import React from 'react';
-import { StyleProp, ViewStyle } from 'react-native';
-type ModalContentWrapperProps = {
-    children: React.ReactElement;
-    visible?: boolean;
-    onShow?: () => void;
-    testID?: string;
-    animationType?: 'none' | 'slide' | 'fade';
-    style?: StyleProp<ViewStyle>;
-    animated?: boolean;
-};
-export type ModalContentWrapperHandler = {
-    hide: (callback?: () => void) => void;
-};
-declare const ModalContentWrapper: React.ForwardRefExoticComponent<ModalContentWrapperProps & React.RefAttributes<ModalContentWrapperHandler>>;
-export default ModalContentWrapper;

package/types/components/Modal/ModalPresenter/ModalPresenter.d.ts

@@ -1,34 +0,0 @@
-import React from 'react';
-import { ViewProps } from 'react-native';
-export type ModalPresenterHandles = {
-    animatedOut: (completion?: () => void) => void;
-};
-export type ModalDismissFunc = (onDismiss?: () => void) => void;
-export type ModalUpdateFunc = (content: React.ReactNode) => void;
-/**
- * Modal handler is returned by `showModal` function.
- */
-export type ModalHandler = {
-    /**
-     * Same `dismiss` function as in `ModalContentProps`.
-     */
-    dismiss: ModalDismissFunc;
-    /**
-     * Same `update` function as in `ModalContentProps`.
-     */
-    update: ModalUpdateFunc;
-};
-declare const ModalPresenter: React.ForwardRefExoticComponent<ViewProps & React.RefAttributes<ModalPresenterHandles>>;
-/**
- * Present a modal on screen immediately.
- *
- * The new presented modal will be on top of existing modals if there are any.
- *
- * @param Content A component to be presented as a modal on screen.
- * This component will be centered horizontally and vertically on screen with
- * a semitransparent black overlay underneath.
- * @param contentProps Props for this modal component.
- * @returns A `ModalHandler` you can use to dismiss the modal.
- */
-export declare const showModal: (content: React.ReactNode) => ModalHandler;
-export default ModalPresenter;

package/types/components/Modal/ModalPresenter/index.d.ts

@@ -1,3 +0,0 @@
-import { ModalDismissFunc, ModalHandler, showModal, ModalPresenterHandles } from './ModalPresenter';
-export type { ModalDismissFunc, ModalHandler, ModalPresenterHandles };
-export { showModal };

package/types/components/Modal/ModalProvider.d.ts

@@ -1,5 +0,0 @@
-import { ReactNode } from 'react';
-declare const ModalProvider: ({ children }: {
-    children: ReactNode;
-}) => JSX.Element;
-export default ModalProvider;