containers/Custom/Group/GroupSendInvites.ts

import {compose} from "recompose";
import SelectGroupMembers from "../../Group/SelectGroupMembers";
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 Send Invites Screen in your custom screen.
 * @component
 * @example
 * //In custom_code/components/MyCustomScreen.js...
 *
 * import React from 'react';
 * import GroupSendInvites from "@src/containers/Custom/Group/GroupSendInvites";
 * const MyCustomScreen = (props) => (
 *     <GroupSendInvites {...props}
 *       groupId={9}
 *       showSearch={false}
 *       hideBackButton={true}
 *       inviteFilters={["invite", "inviteFriends"]}
 *       screenTitle="Send Invitations"
 *       hideNavigationHeader={false}
 *     />
 * )
 *
 *
 * 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 GroupSendInvites = compose(
	withNavigation,
	withActiveCallBacks
)(SelectGroupMembers);

export default withLoadGroup(GroupSendInvites);

GroupSendInvites.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 `true` to hide the back button
	 * {Boolean}
	 */
	hideBackButton: PropTypes.bool,
	/**
	 * Use `true` to hide the screen title container
	 * {Boolean}
	 */
	hideNavigationHeader: PropTypes.bool,
	/**
	 * Use this to modify the available filters.
	 * Available values: `invite`, `inviteFriends`
	 * {Array}
	 */
	inviteFilters: PropTypes.array,
	/**
	 * List screen title
	 * {String}
	 */
	screenTitle: PropTypes.string,
	/**
	 * Use `false` to hide search box
	 * {Boolean}
	 */
	showSearch: PropTypes.bool,
	/**
	 * Use this to display your own loading component while the screen is loading
	 * {ReactComponent}
	 */
	LoadingComponent: PropTypes.elementType
};