containers/Custom/Group/GroupInviteScreen.ts

import {compose} from "recompose";
import GroupInvite from "../../Group/GroupInviteScreen";
import PropTypes from "prop-types";
import withActiveCallBacks from "../../../navigators/react-navigation-addons/withActiveCallBacks";
import {withNavigation} from "../../../components/hocs/withNavigation";
import withLoadGroup from "../../../components/hocs/withLoadGroup";

/**
 * You can use this component to display Groups Invite Screen in your custom screen.
 * @component
 * @example
 * //In custom_code/components/MyCustomScreen.js...
 *
 * import React, {useContext, useEffect} from "react";
 * import {Text, StyleSheet} from "react-native";
 * import {NavigationContext} from "@react-navigation/native";
 *
 * import {backButton} from "@src/utils";
 * import GroupInviteScreen from "@src/containers/Custom/Group/GroupInviteScreen";
 * import {useScreenProps} from "@src/navigators/v5/ScreenPropsProvider";
 *
 * const MyCustomScreen = props => {
 *     const {global, colors, t} = useScreenProps([
 *         "global",
 *         "colors",
 *         "t",
 *         "calcFontSize"
 *     ]);
 *
 *     const {params = {}} = props.route;
 *     const {borderColor} = colors;
 *
 *     const options = () => {
 *         return {
 *             headerShown: true,
 *             headerTitleAlign: "center",
 *             headerTitle: () => (
 *                 <Text
 *                     ellipsizeMode="tail"
 *                     numberOfLines={1}
 *                     style={global.appHeaderTitle}
 *                 >
 *                     {t("group:invites")}
 *                 </Text>
 *             ),
 *             headerLeft: () =>
 *                 backButton({
 *                     navigation,
 *                     headerColor: colors.headerIconColor,
 *                     text: t("common:back"),
 *                     textStyle: global.headerText,
 *                     colors
 *                 }),
 *             headerStyle: {
 *                 ...StyleSheet.flatten(global.header),
 *                 borderBottomColor: borderColor,
 *                 borderBottomWidth: StyleSheet.hairlineWidth
 *             }
 *         };
 *     };
 *
 *     const navigation = useContext(NavigationContext);
 *
 *     useEffect(
 *         () => {
 *             navigation?.setOptions(options());
 *         },
 *         [params]
 *     );
 *
 *     return <GroupInviteScreen {...props} groupId={1} />;
 * };
 *
 * 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"
 *  );
 * }
 */

export const GroupInviteScreen = compose(
	withNavigation,
	withActiveCallBacks
)(GroupInvite);

export default withLoadGroup(GroupInviteScreen);

GroupInviteScreen.propTypes = {
	/**
	 * Id of group to display
	 * {Number}
	 */
	groupId: PropTypes.number,
	/**
	 * If the group is not yet available in the app state, the component will attempt to load a list of groups.
	 * You can use this field to search for the specific group you want to load instead of loading a list of groups.
	 * {String}
	 */
	searchTerm: PropTypes.string,
	/**
	 * Use this to display your own loading component while the screen is loading
	 * {ReactComponent}
	 */
	LoadingComponent: PropTypes.elementType
};