containers/Custom/Group/GroupMessageOptionsScreen.ts

import {compose} from "recompose";
import GroupMessageOptions from "../../Group/GroupMessageOptionsScreen";
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 Group Message Options Screen in your custom screen.
 * @component
 * @example
 * //In custom_code/components/MyCustomScreen.js...
 *
 * import React from 'react';
 * import { View, Text } from 'react-native';
 * import GroupMessageOptionsScreen from "@src/containers/Custom/Group/GroupMessageOptionsScreen";
 *
 * const MyCustomScreen = (props) => (
 *   <GroupMessageOptionsScreen {...props}
 *     groupId={9}
 *     messageOptionsIntro="Hello World"
 *     tabListOptions={["allMembersGroupMessage", "selectedMembersGroupMessage", "privateMessage"]}
 *     hideBackButton={true}
 *     // hideNavigationHeader={true}
 *     screenTitle="Send Messages"
 *     LoadingComponent={<View style={{ flex: 1, alignSelf: "center", justifyContent: "center" }}>
 *       <Text>Loading, please wait...</Text>
 *     </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"
 *  );
 * }
 */

export const GroupMessageOptionsScreen = compose(
	withNavigation,
	withActiveCallBacks
)(GroupMessageOptions);

export default withLoadGroup(GroupMessageOptionsScreen);

GroupMessageOptionsScreen.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,
	/**
	 * Message options introduction. Default value comes from BuddyBoss translation
	 * {String}
	 */
	messageOptionsIntro: PropTypes.string,
	/**
	 * List screen title
	 * {String}
	 */
	screenTitle: PropTypes.string,
	/**
	 * Use this to modify the available tab options.
	 * Available values: `allMembersGroupMessage`, `selectedMembersGroupMessage`, `privateMessage`
	 * {Array}
	 */
	tabListOptions: PropTypes.array,
	/**
	 * Use this to display your own loading component while the screen is loading
	 * {ReactComponent}
	 */
	LoadingComponent: PropTypes.elementType
};