containers/Custom/Profile/XProfileScreen.ts

import {compose} from "recompose";
import XProfile from "../../Profile/XProfileScreen";
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 XProfile Screen in your custom screen.
 * @component
 * @example <caption> Create a customized header for the profile screen </caption>
 * //In custom_code/components/MyCustomScreen.js...
 * import React from 'react';
 * import {View, Text} from "react-native";
 * import XProfileScreen from "@src/containers/Custom/Profile/XProfileScreen";
 *
 * const MyCustomScreen = (props) => {
 *
 *  if (!props.isFocused)
 *    return null;
 *
 *  return (
 *    <>
 *      <View style={{flex: 0.1, alignItems: "center", justifyContent: "center"}}>
 *        <Text> This is my profile </Text>
 *      </View>
 *      <View style={{flex: 0.9}}>
 *        <XProfileScreen
 *          screenTitle="My Profile"
 *          hideBackButton={true}
 *          hideEditButton={true}
 *          hideNavigationHeader={true}
 *          {...props}
 *        />
 *      </View>
 *
 *    </>
 *  )
 * }
 *
 *
 * 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 XProfileScreen = compose(
	withNavigation,
	withActiveCallBacks
)(XProfile);

export default withLoadProfile(XProfileScreen);

XProfileScreen.propTypes = {
	/**
	 * You can use this to display a specific user's profile 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 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 new activity button
	 * {Boolean}
	 */
	hideEditButton: PropTypes.bool,
	/**
	 * Use `true` to hide the screen title container
	 * {Boolean}
	 */
	hideNavigationHeader: PropTypes.bool,
	/**
	 * Use this to display your own loading component while the screen is loading
	 * {ReactComponent}
	 */
	LoadingComponent: PropTypes.elementType
};