containers/Custom/Group/GroupDocumentsScreen.ts

import {compose} from "recompose";
import GroupDocuments from "../../Group/GroupDocumentsScreen";
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 Documents Screen in your custom screen.
 * @component
 * @example
 * //In custom_code/components/MyCustomScreen.js...
 *
 * import React from 'react';
 * import { View, Text } from 'react-native';
 * import GroupDocumentsScreen from "@src/containers/Custom/Group/GroupDocumentsScreen";
 * const MyCustomScreen = (props) => (
 * <GroupDocumentsScreen
 *     {...props}
 *     groupId={6}
 *     folderId={2}
 *     showSearch={false}
 *     searchTerm="Starbucks"
 *     screenTitle="Starbucks Documents"
 *     hideFilters={true}
 *     hideBackButton={true}
 *     hideNavigationHeader={true}
 *     headerHeight={0}
 *     hideNewDocumentButton={true}
 *     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 GroupDocumentsScreen = compose(
	withNavigation,
	withActiveCallBacks
)(GroupDocuments);

export default withLoadGroup(GroupDocumentsScreen);

GroupDocumentsScreen.propTypes = {
	/**
	 * Id of group to display
	 * {Number}
	 */
	groupId: PropTypes.number,
	/**
	 * Id of document folder to display
	 * {Number}
	 */
	folderId: 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 filters in the screen
	 */
	hideFilters: PropTypes.bool,
	/**
	 * Use `true` to hide the screen title container when scrolling
	 * {Boolean}
	 */
	hideNavigationHeader: PropTypes.bool,
	/**
	 * Use `true` to hide the new document button
	 * {Boolean}
	 */
	hideNewDocumentButton: 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
};