import React from 'react'; import { StyleSheet } from 'react-native'; import SplitHostNativeComponent, { Commands as SplitHostNativeCommands, } from '../../../fabric/gamma/split/SplitHostNativeComponent'; import type { SplitDisplayMode, SplitHostProps, SplitBehavior, } from './SplitHost.types'; import SplitScreen from './SplitScreen'; type NativeRef = React.ComponentRef; // According to the UIKit documentation: https://developer.apple.com/documentation/uikit/uisplitviewcontroller/displaymode-swift.enum // Only specific pairs for displayMode - splitBehavior are valid and others may lead to unexpected results. // Therefore, we're adding check on the JS side to return a feedback to the client when that pairing isn't valid. // However, we're not blocking these props to be set on the native side, because it doesn't crash, just the result or transitions may not work as expected. const displayModeForSplitCompatibilityMap: Record< SplitBehavior, SplitDisplayMode[] > = { tile: ['secondaryOnly', 'oneBesideSecondary', 'twoBesideSecondary'], overlay: ['secondaryOnly', 'oneOverSecondary', 'twoOverSecondary'], displace: ['secondaryOnly', 'oneBesideSecondary', 'twoDisplaceSecondary'], automatic: [], // placeholder for satisfying types; we'll handle it specially in logic }; const isValidDisplayModeForSplitBehavior = ( displayMode: SplitDisplayMode, splitBehavior: SplitBehavior, ) => { if (splitBehavior === 'automatic') { // for automatic we cannot easily verify the compatibility, because it depends on the system preference for display mode, therefore we're assuming that 'automatic' has only valid combinations return true; } return displayModeForSplitCompatibilityMap[splitBehavior].includes( displayMode, ); }; /** * EXPERIMENTAL API, MIGHT CHANGE W/O ANY NOTICE */ function SplitHost({ ref, ...props }: SplitHostProps) { const { preferredDisplayMode, preferredSplitBehavior } = props; const nativeRef = React.useRef(null); React.useImperativeHandle( ref, () => ({ show: column => { if (nativeRef.current) { SplitHostNativeCommands.showColumn(nativeRef.current, column); } else { console.warn( '[RNScreens] Reference to native SplitHost component has not been updated yet', ); } }, }), [], ); React.useEffect(() => { if (preferredDisplayMode && preferredSplitBehavior) { const isValid = isValidDisplayModeForSplitBehavior( preferredDisplayMode, preferredSplitBehavior, ); if (!isValid) { const validDisplayModes = displayModeForSplitCompatibilityMap[preferredSplitBehavior]; console.warn( `Invalid display mode "${preferredDisplayMode}" for split behavior "${preferredSplitBehavior}".` + `\nValid modes for "${preferredSplitBehavior}" are: ${validDisplayModes.join( ', ', )}.`, ); } } }, [preferredDisplayMode, preferredSplitBehavior]); const children = React.Children.toArray(props.children); const columns = children.filter( // @ts-ignore - type is valid attribute for child child => child.type === SplitScreen.Column, ); const inspectors = children.filter( // @ts-ignore - type is valid attribute for child child => child.type === SplitScreen.Inspector, ); return ( {props.children} ); } const styles = StyleSheet.create({ container: { flex: 1, }, }); export default SplitHost;