containers/Custom/Profile/ProfileFriendsScreen.ts

import {compose} from "recompose";
import ProfileFriends from "../../Profile/ProfileFriendsScreen";
import withActiveCallBacks from "../../../navigators/react-navigation-addons/withActiveCallBacks";
import {withNavigation} from "../../../components/hocs/withNavigation";
import withLoadProfile from "../../../components/hocs/withLoadProfile";
import PropTypes from "prop-types";

/**
 * You can use this component to display the Profile Friends Screen in your custom screen.
 * @component
 * @example
 * //In custom_code/components/MyCustomScreen.js...
 *
 * import React from 'react';
 * import {View, Text} from "react-native";
 * import ProfileFriendsScreen from "@src/containers/Custom/Profile/ProfileFriendsScreen";
 *
 * const MyCustomScreen = (props) => {
 *
 *  if (!props.isFocused)
 *    return null;
 *
 *  return (
 *    <>
 *        <View style={{marginTop: 40, paddingVertical: 30, alignItems: "center", backgroundColor: "gray"}}>
 *          <Text style={{color: "white"}}> Friends of Steve </Text>
 *        </View>
 *        <ProfileFriendsScreen
 *          userId={3}
 *          searchTerm="Steve"
 *          // screenTitle="Friends of Steve"
 *          hideBackButton={true}
 *          hideNavigationHeader={true}
 *          headerHeight={50}
 *          {...props}
 *        />
 *    </>
 *  )
 * }
 *
 *
 * export default MyCustomScreen;
 *
 * //In custom_code/index.js...
 *
 * ...
 *
 * import MyCustomScreen from "./components/MyCustomScreen";
 * export const applyCustomCode = externalCodeSetup => {
 *  externalCodeSetup.navigationApi.addNavigationRoute(
 *    "book",
 *    "BookScreen",
 *    MyCustomScreen,
 *    "All"
 *  );
 *  externalCodeSetup.navigationApi.addNavigationRoute(
 *    "book",
 *    "BookScreen",
 *    MyCustomScreen,
 *    "Main"
 *  );
 * }
 *
 */
const ProfileFriendsScreen = compose(
	withNavigation,
	withActiveCallBacks
)(ProfileFriends);

export default withLoadProfile(ProfileFriendsScreen);

ProfileFriendsScreen.propTypes = {
	/**
	 * You can use this to display a specific user's profile friends by assigning their userId as this props's value
	 * {Number}
	 */
	userId: PropTypes.number,
	/**
	 * List screen title
	 * {String}
	 */
	screenTitle: PropTypes.string,
	/**
	 * If the user is not yet available in the app state, the component will attempt to load a list of users.
	 * You can use this field to search for the specific user you want to load instead of loading a list of users.
	 * {String}
	 */
	searchTerm: PropTypes.string,
	/**
	 * Use `true` to hide the filters in the screen
	 * {Boolean}
	 */
	hideFilters: PropTypes.bool,
	/**
	 * Use `true` to hide the back button.
	 * By default, the button will use react-navigation's goBack() function.
	 * This can be changed using the `setBackButtonRenderer` hook.
	 * {Boolean}
	 */
	hideBackButton: PropTypes.bool,
	/**
	 * Use `true` to hide the screen title container when scrolling
	 * {Boolean}
	 */
	hideNavigationHeader: PropTypes.bool,
	/**
	 * Define header height
	 * {Number}
	 */
	headerHeight: PropTypes.number,
	/**
	 * Use this to display your own loading component while the screen is loading
	 * {ReactComponent}
	 */
	LoadingComponent: PropTypes.elementType
};