123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
-
- <meta charset="utf-8">
- <meta name="viewport" content="width=device-width, initial-scale=1">
- <title> src/components/LandmarkDetails.tsx</title>
- <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
- <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
- <script src="./build/entry.js"></script>
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
- <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
- <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
- <link type="text/css" rel="stylesheet" href="styles/app.min.css">
- <link type="text/css" rel="stylesheet" href="styles/iframe.css">
- <link type="text/css" rel="stylesheet" href="">
- <script async defer src="https://buttons.github.io/buttons.js"></script>
-
- </head>
- <body class="layout small-header">
- <div id="stickyNavbarOverlay"></div>
-
- <div class="top-nav">
- <div class="inner">
- <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
- <span aria-hidden="true"></span>
- <span aria-hidden="true"></span>
- <span aria-hidden="true"></span>
- </a>
- <div class="logo">
-
-
- </div>
- <div class="menu">
-
- <div class="navigation">
- <a
- href="index.html"
- class="link"
- >
- API Documentation
- </a>
-
-
-
- </div>
- </div>
- </div>
- </div>
- <div id="main">
- <div
- class="sidebar "
- id="sidebarNav"
- >
-
- <nav>
-
- <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Interfaces</h3><ul><li><a href="AddLandmarkProps.html">AddLandmarkProps</a></li><li><a href="CommentProps.html">CommentProps</a></li><li><a href="IdToken.html">IdToken</a></li><li><a href="IntroProps.html">IntroProps</a></li><li><a href="Landmark.html">Landmark</a></li><li><a href="LandmarkDetailsProps.html">LandmarkDetailsProps</a></li><li><a href="LandmarkPinProps.html">LandmarkPinProps</a></li><li><a href="LMComment.html">LMComment</a></li><li><a href="ProfileProps.html">ProfileProps</a></li><li><a href="RegisterProps.html">RegisterProps</a></li><li><a href="UserProfile.html">UserProfile</a></li></ul><h3>Components</h3><ul><li><a href="App.html">App</a></li><li><a href="Atlas.html">Atlas</a></li><li><a href="Comment.html">Comment</a></li><li><a href="PrimaryButton.html">PrimaryButton</a></li><li><a href="Profile.html">Profile</a></li><li><a href="SecondaryButton.html">SecondaryButton</a></li></ul><h3>Global</h3><ul><li><a href="global.html#IconStrings">IconStrings</a></li></ul></div><div class="category"><h2>Hooks</h2><h3>Namespaces</h3><ul><li><a href="useAuth.html">useAuth</a></li><li><a href="useLandmarks.html">useLandmarks</a></li><li><a href="useProfile.html">useProfile</a></li></ul></div><div class="category"><h2>Map</h2><h3>Interfaces</h3><ul><li><a href="UserLocation.html">UserLocation</a></li></ul><h3>Components</h3><ul><li><a href="AddLandmark.html">AddLandmark</a></li><li><a href="LandmarkDetails.html">LandmarkDetails</a></li><li><a href="LandmarkPin.html">LandmarkPin</a></li><li><a href="Map.html">Map</a></li></ul></div><div class="category"><h2>Navigation</h2><h3>Components</h3><ul><li><a href="AuthorizedNavigator.html">AuthorizedNavigator</a></li><li><a href="UnauthorizedNavigator.html">UnauthorizedNavigator</a></li></ul><h3><a href="global.html">Global</a></h3></div><div class="category"><h2>Stores</h2><h3>Classes</h3><ul><li><a href="AuthStore.html">AuthStore</a></li></ul></div><div class="category"><h2>Unauthorized</h2><h3>Components</h3><ul><li><a href="Intro.html">Intro</a></li><li><a href="UnauthorizedLayout.html">UnauthorizedLayout</a></li></ul><h3>Components / Registration</h3><ul><li><a href="RegisterMain.html">RegisterMain</a></li></ul></div>
-
- </nav>
- </div>
- <div class="core" id="main-content-wrapper">
- <div class="content">
- <header class="page-title">
- <p>Source</p>
- <h1>src/components/LandmarkDetails.tsx</h1>
- </header>
-
-
- <section>
- <article>
- <pre class="prettyprint source linenums"><code>import { FontAwesome } from "@expo/vector-icons";
- import React, { memo, useCallback, useEffect, useRef, useState } from "react";
- import { ActivityIndicator, Dimensions, Image, Keyboard, ListRenderItem, StyleSheet, Text, TextInput, View } from "react-native";
- import { ScrollView, TouchableWithoutFeedback } from "react-native-gesture-handler";
- import Picker from "react-native-picker-select";
- import { colors, Icons, IconStrings } from "../globals";
- import { Landmark, LMComment, useLandmarks } from "../hooks/useLandmarks";
- import { authStore } from "../stores/AuthStore";
- import { PrimaryButton } from "./Auth/Buttons";
- /**
- * Props for the {@link Comment} component.
- */
- export interface CommentProps {
- /**
- * The [comment]{@link LMComment} object being displayed by the {@link Comment} component.
- */
- comment: LMComment
- }
- /**
- * Component that displays a {@link LMComment} object in a clean format.
- * @component
- */
- export const Comment: React.FC<CommentProps> = ({comment}) => (
- <View>
- <Text testID="comment-text">{comment.text}</Text>
- </View>
- )
- /**
- * Props for the {@link LandmarkDetails} component.
- */
- export interface LandmarkDetailsProps {
- /**
- * The {@link Landmark} object being displayed/edited in the {@link LandmarkDetails} modal.
- */
- landmark: Landmark | undefined
- /**
- * A callback passed from the parent {@link Map} that toggles the visibility of the {@link LandmarkDetails} modal.
- */
- setVisible: (state: boolean) => void;
- /**
- * A callback passed from the parent {@link Map} that toggles the ability to edit the {@link Landmark} in {@link LandmarkDetails} modal.
- */
- setEditing: (state: boolean) => void;
- /**
- * A flag that determines whether the properties of the {@link Landmark} displayed in the {@link LandmarkDetails} modal can be edited
- */
- editingEnabled: boolean
- }
- /**
- * Component that renders the details of a selected {@link Landmark} and allows the user to edit those details. Contained within a [react-native-modal]{@link https://github.com/react-native-modal/react-native-modal}.
- * @component
- * @category Map
- */
- const LandmarkDetails: React.FC<LandmarkDetailsProps> = ({landmark, setVisible, setEditing, editingEnabled}) => {
- /**
- * Holds the state of the {@link Landmark} being displayed.
- */
- const selectedLandmarkState = undefined;
- const [selectedLandmark, setLandmark] = useState<Landmark | undefined>(selectedLandmarkState);
- /**
- * Holds state of a {@link Landmark} object parallel to {@linkcode selectedLandmarkState} that is manipulated when {@linkcode editingEnabled} is true.
- */
- const updatedLandmarkState = undefined;
- const [updatedLandmark, setUpdatedLandmark] = useState<Landmark | undefined>(updatedLandmarkState);
- const {
- updateLandmark, updateLandmarkStatus, resetUpdateLm,
- deleteLandmark, deleteLandmarkStatus, resetDeleteLm,
- } = useLandmarks(undefined);
- useEffect(() => {
- /**
- * Updates this component's {@linkcode selectedLandmarkState} when the {@linkcode landmark} prop passed down from the parent {@link Map}'s {@linkcode selectedLandmark} is changed.
- * Embedded in a useEffect that listens to the {@linkcode landmark} prop.
- * @memberOf LandmarkDetails
- */
- const updateLandmarkStateFromParent = () => {
- setLandmark(landmark)
- };
- updateLandmarkStateFromParent();
- }, [landmark])
- useEffect(() => {
- /**
- * Resets the {@linkcode updateLandmark} mutation on successful add.
- * Embedded in a useEffect that listens to the {@linkcode updateLandmarkStatus} value from the {@link useLandmarks} hook.
- * @memberOf LandmarkDetails
- */
- const resetUpdateMutationOnSuccess = () => {
- if (updateLandmarkStatus == 'success') {
- resetUpdateLm();
- setLandmark(updatedLandmark)
- }
- }
- resetUpdateMutationOnSuccess();
- }, [updateLandmarkStatus]);
- useEffect(() => {
- /**
- * Resets the {@linkcode deleteLandmark} mutation on successful delete.
- * Embedded in a useEffect that listens to the {@linkcode deleteLandmarkStatus} value from the {@link useLandmarks} hook.
- * @memberOf LandmarkDetails
- */
- const resetDeleteMutationOnSuccess = () => {
- if (deleteLandmarkStatus == 'success') {
- resetDeleteLm();
- }
- }
- resetDeleteMutationOnSuccess();
- }, [deleteLandmarkStatus]);
- /**
- * Toggles whether or not the {@linkcode selectedLandmark} can be edited through the {@linkcode editingEnabled} prop.
- */
- const toggleEditing = (editingState: boolean) => {
- if (editingState) { setUpdatedLandmark(selectedLandmark); }
- else { setUpdatedLandmark(undefined); }
- setEditing(editingState);
- }
- /**
- * Calls the {@linkcode updateLandmark} mutation from the {@link useLandmarks} hook and closes the modal once finished.
- */
- const editLandmark = async () => {
- if (updatedLandmark) {
- await updateLandmark(updatedLandmark);
- }
-
- setEditing(false);
- }
- /**
- * Calls the {@linkcode deleteLandmark} mutation from the {@link useLandmarks} hook and closes the modal once finished.
- */
- const removeLandmark = async () => {
- await deleteLandmark(selectedLandmark?.id);
- setVisible(false);
- }
- /**
- * Renders all [comments]{@link LMComment} associated with the {@linkcode selectedLandmark} as items for the [FlatList]{@link https://reactnative.dev/docs/flatlist} in this component.
- */
- const renderComment: ListRenderItem<LMComment> = useCallback(({item}) => (
- <Comment comment={item} />
- ), []);
- return (
- <View style={[styles.container, editingEnabled ? {height: Dimensions.get("window").height * .4,} : {height: Dimensions.get("window").height * .4,}]}>
- {updateLandmarkStatus == "idle" && deleteLandmarkStatus == "idle" ?
- <>
- <View style={styles.detailsHeader}>
- {authStore.userId !== selectedLandmark?.user ? null : !editingEnabled ?
- <View style={{flexDirection: 'row', alignItems: "center"}}>
- <FontAwesome style={{marginRight: 20, marginTop: 2}} size={25} color="white" name="edit" onPress={() => toggleEditing(true)}/>
- <FontAwesome color="white" size={25} name="trash" onPress={async () => removeLandmark()}/>
- </View> :
- <View style={{flexDirection: 'row', alignItems: "center",}}>
- <FontAwesome color="white" size={25} name="close" onPress={() => toggleEditing(false)}/>
- </View>}
- {!editingEnabled ?
- <FontAwesome color="white" size={25} name="close" onPress={() => setVisible(false)}/>:
- updatedLandmark?.description && updatedLandmark.landmark_type ?
- <FontAwesome style={{marginTop: 2}} size={25} color="white" name="check" onPress={async () => editLandmark()}/> : null}
- </View>
- <View style={styles.detailsContainer}>
- {editingEnabled ?
- <View>
- <View style={{flexDirection: 'row', marginBottom: 20, justifyContent: "space-between"}}>
- {updatedLandmark?.landmark_type ?
- <>
- <Picker
- style={{
- inputIOS: {color: 'white'},
- inputAndroid: {color: 'white'},
- viewContainer: {marginVertical: 10, flex: 1}, placeholder: {color: 'white'}}}
- textInputProps={{placeholderTextColor: 'white', selectionColor: 'white'}}
- Icon={() => <FontAwesome name="chevron-down" color='white' size={20} />}
- placeholder={
- selectedLandmark?.landmark_type ?
- {label: IconStrings[selectedLandmark.landmark_type].toUpperCase(), value: selectedLandmark.landmark_type} :
- {label: "Select landmark type", value: 0} }
- value={updatedLandmark.landmark_type}
- onValueChange={(value) => {
- setUpdatedLandmark({...updatedLandmark, landmark_type: value, title: IconStrings[value]})
- }}
- useNativeAndroidPickerStyle={true}
- items={Object.keys(Icons)?.filter(icon => parseInt(icon) != selectedLandmark?.landmark_type).map(icon => {
- return (
- {label: IconStrings[parseInt(icon)].toUpperCase(), value: icon, key: icon}
- )})}
- />
- <Image style={{marginLeft: 20}} source={Icons[updatedLandmark.landmark_type]}/>
- </>
- : null}
- </View>
- <TouchableWithoutFeedback style={{marginBottom: 20}} onPress={() => Keyboard.dismiss()}>
- <ScrollView style={{backgroundColor: 'white'}}>
- <TextInput
- multiline={true}
- style={[styles.input, {fontSize: 13, marginBottom: 10}]}
- onChangeText={(value) => setUpdatedLandmark({...updatedLandmark, description: value})} >
- {updatedLandmark?.description}
- </TextInput>
- </ScrollView>
- </TouchableWithoutFeedback>
- </View>:
- <View style={{flexDirection: 'row'}}>
- <View style={{flex: 8, flexDirection: 'column', marginBottom: 20}}>
- <Text style={{color: 'white', marginBottom: 10, fontSize: 15}}>{selectedLandmark?.title?.toUpperCase()}</Text>
- <ScrollView>
- <Text style={{color: 'white', fontSize: 13}}>{selectedLandmark?.description}</Text>
- </ScrollView>
- </View>
- {selectedLandmark?.landmark_type ? <Image source={Icons[selectedLandmark.landmark_type]} /> : null}
- </View>}
- <TouchableWithoutFeedback style={{height: '100%'}} onPress={() => Keyboard.dismiss()}><Text></Text></TouchableWithoutFeedback>
- {/* {!editingEnabled ?
- <View style={styles.commentContainer}>
- <Text style={{color: 'white', marginBottom: 20}}>Comments: </Text>
- <FlatList<LMComment>
- keyExtractor={i => i.id}
- data={[
- {id: '1', text: 'Hello', poster: 'chase'}, {id: '3', text: 'Hello', poster: 'chase'}, {id: '2', text: 'Hello', poster: 'chase'},
- {id: '4', text: 'Hello', poster: 'chase'}, {id: '5', text: 'Hello', poster: 'chase'}, {id: '6', text: 'Hello', poster: 'chase'},
- {id: '9', text: 'Hello', poster: 'chase'}, {id: '8', text: 'Hello', poster: 'chase'}, {id: '7', text: 'Hello', poster: 'chase'},
- {id: '12', text: 'Hello', poster: 'chase'}, {id: '10', text: 'Hello', poster: 'chase'}, {id: '11', text: 'Hello', poster: 'chase'},
- ]}
- renderItem={renderComment}
- style={{backgroundColor: 'white'}}/>
-
- </View> : null} */}
- </View>
- </> :
- <View style={{height: '100%', justifyContent: "space-evenly", alignItems: "center", marginHorizontal: 20}}>
- <Text style={{color: 'white', fontSize: 20}}>{
- deleteLandmarkStatus == 'loading' ? "Deleting landmark..." :
- deleteLandmarkStatus == 'error' ? "Something went wrong trying to delete the landmark" :
- updateLandmarkStatus == 'loading' ? "Updating landmark..." :
- updateLandmarkStatus == 'error' ? "Something went wrong trying to update the landmark" : null}
- </Text>
- {
- deleteLandmarkStatus == 'loading' || updateLandmarkStatus == 'loading' ? <ActivityIndicator color='white' size="large"/> :
- deleteLandmarkStatus == 'error' || updateLandmarkStatus == 'error' ? <PrimaryButton text="Okay" style={{borderColor: 'white', borderWidth: 1}} onPress={() => setVisible(false)} /> : null
- }
- </View> }
- </View>
- )
- }
- const styles = StyleSheet.create({
- container: {
- backgroundColor: colors.red,
- },
- detailsHeader: {
- borderBottomWidth: 1,
- borderColor: 'white',
- flexDirection: 'row',
- justifyContent: 'space-between',
- alignItems: 'center',
- backgroundColor: '#df3f3f',
- marginBottom: 10,
- paddingVertical: 10,
- paddingHorizontal: 20
- },
- detailsContainer: {
- flex: 1,
- marginHorizontal: 20
- },
- commentContainer: {
- flex: 5,
- marginBottom: 40
- },
- title: {
- },
- input: {
- padding: 5,
- color: 'black'
- }
- })
- export default memo(LandmarkDetails);</code></pre>
- </article>
- </section>
- </div>
-
- <footer class="footer">
- <div class="content has-text-centered">
- <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a></p>
- <p class="sidebar-created-by">
- <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
- <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
- </p>
- </div>
- </footer>
-
- </div>
- <div id="side-nav" class="side-nav">
- </div>
- </div>
- <script src="scripts/app.min.js"></script>
- <script>PR.prettyPrint();</script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|