containers/Custom/Group/GroupActivitiesScreen.ts

import {compose} from "recompose";
import {Activities} from "../../Group/Activities";
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 Activities Screen in your custom screen.
 * @component
 * @example
 * //In custom_code/components/MyCustomScreen.js...
 *
 * import React from 'react';
 * import { View, Text } from 'react-native';
 * import GroupActivitiesScreen from "@src/containers/Custom/Group/GroupActivitiesScreen";
 * import { useSelector } from 'react-redux';
 * const MyCustomScreen = (props) => {
 *
 *    const groupId = 9;
 *    const group = useSelector(state => state.groupsCache.byId.get(groupId.toString()));
 *    return <>
 *        <View style={{ marginTop: 40, padding: 10 }}>
 *            <Text>You are the {group?.role} of {group?.name} group</Text>
 *        </View>
 *        <GroupActivitiesScreen {...props}
 *            groupId={groupId}
 *            showSearch={true}
 *            headerHeight={0}
 *            hideBackButton={true}
 *            // hideNavigationHeader={true}
 *            // hideNewActivityButton={true}
 *            // screenTitle="Hello World"
 *            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 GroupActivitiesScreen = compose(
	withNavigation,
	withActiveCallBacks
)(Activities);

export default withLoadGroup(GroupActivitiesScreen);

GroupActivitiesScreen.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,
	/**
	 * Define header height
	 * {Number}
	 */
	headerHeight: PropTypes.number,
	/**
	 * Use `true` to hide the back button
	 * {Boolean}
	 */
	hideBackButton: PropTypes.bool,
	/**
	 * Use `true` to hide the screen title container when scrolling
	 * {Boolean}
	 */
	hideNavigationHeader: PropTypes.bool,
	/**
	 * Use `true` to hide the new activity button
	 * {Boolean}
	 */
	hideNewActivityButton: PropTypes.bool,
	/**
	 * 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
};