global.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <title> Global</title>
  7. <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
  8. <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
  9. <script src="./build/entry.js"></script>
  10. <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
  11. <!--[if lt IE 9]>
  12. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  13. <![endif]-->
  14. <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
  15. <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
  16. <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
  17. <link type="text/css" rel="stylesheet" href="styles/app.min.css">
  18. <link type="text/css" rel="stylesheet" href="styles/iframe.css">
  19. <link type="text/css" rel="stylesheet" href="">
  20. <script async defer src="https://buttons.github.io/buttons.js"></script>
  21. </head>
  22. <body class="layout small-header">
  23. <div id="stickyNavbarOverlay"></div>
  24. <div class="top-nav">
  25. <div class="inner">
  26. <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
  27. <span aria-hidden="true"></span>
  28. <span aria-hidden="true"></span>
  29. <span aria-hidden="true"></span>
  30. </a>
  31. <div class="logo">
  32. </div>
  33. <div class="menu">
  34. <div class="navigation">
  35. <a
  36. href="index.html"
  37. class="link"
  38. >
  39. API Documentation
  40. </a>
  41. </div>
  42. </div>
  43. </div>
  44. </div>
  45. <div id="main">
  46. <div
  47. class="sidebar "
  48. id="sidebarNav"
  49. >
  50. <nav>
  51. <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>
  52. </nav>
  53. </div>
  54. <div class="core" id="main-content-wrapper">
  55. <div class="content">
  56. <header class="page-title">
  57. <p>Title</p>
  58. <h1>Global</h1>
  59. </header>
  60. <section>
  61. <header>
  62. <h2></h2>
  63. </header>
  64. <article>
  65. <div class="container-overview">
  66. <dl class="details">
  67. </dl>
  68. </div>
  69. <div class='vertical-section'>
  70. <h1>Members</h1>
  71. <div class="members">
  72. <div class="member">
  73. <h4 class="name" id="IconStrings">
  74. <a class="href-link" href="#IconStrings">#</a>
  75. <span class='tag'>constant</span>
  76. <span class="code-name">
  77. IconStrings
  78. </span>
  79. </h4>
  80. <div class="description">
  81. <p>Array that maps <code>landmark_type</code> from <a href="Landmark.html">Landmark</a> to a string representing that landmark type.</p>
  82. </div>
  83. <dl class="details">
  84. <p class="tag-source">
  85. <a href="src_globals.ts.html" class="button">View Source</a>
  86. <span>
  87. <a href="src_globals.ts.html">src/globals.ts</a>, <a href="src_globals.ts.html#line19">line 19</a>
  88. </span>
  89. </p>
  90. </dl>
  91. </div>
  92. </div>
  93. </div>
  94. <div class='vertical-section'>
  95. <h1>Type Definitions</h1>
  96. <div class="members">
  97. <div class="member">
  98. <span class="method-parameter is-pulled-right">
  99. <label>Type:</label>
  100. <span class="param-type">object</span>
  101. </span>
  102. <h4 class="name" id="AuthStackParamList">
  103. <a class="href-link" href="#AuthStackParamList">#</a>
  104. <span class="code-name">
  105. AuthStackParamList
  106. </span>
  107. </h4>
  108. <div class="description">
  109. <p>Permitted screens for the Auth stack navigator.</p>
  110. </div>
  111. <h5 class="subsection-title">Properties:</h5>
  112. <div class="table-container">
  113. <table class="props table">
  114. <thead>
  115. <tr>
  116. <th>Name</th>
  117. <th>Type</th>
  118. <th class="last">Description</th>
  119. </tr>
  120. </thead>
  121. <tbody>
  122. <tr class="deep-level-0">
  123. <td class="name"><code>Intro</code></td>
  124. <td class="type">
  125. <span class="param-type">React.FC</span>
  126. </td>
  127. <td class="description last"></td>
  128. </tr>
  129. <tr class="deep-level-0">
  130. <td class="name"><code>Login</code></td>
  131. <td class="type">
  132. <span class="param-type">React.FC</span>
  133. </td>
  134. <td class="description last"></td>
  135. </tr>
  136. <tr class="deep-level-0">
  137. <td class="name"><code>Register</code></td>
  138. <td class="type">
  139. <span class="param-type">React.FC</span>
  140. </td>
  141. <td class="description last"></td>
  142. </tr>
  143. </tbody>
  144. </table>
  145. </div>
  146. <dl class="details">
  147. <p class="tag-source">
  148. <a href="src_navigation_UnauthorizedNavigator.tsx.html" class="button">View Source</a>
  149. <span>
  150. <a href="src_navigation_UnauthorizedNavigator.tsx.html">src/navigation/UnauthorizedNavigator.tsx</a>, <a href="src_navigation_UnauthorizedNavigator.tsx.html#line32">line 32</a>
  151. </span>
  152. </p>
  153. </dl>
  154. </div>
  155. </div>
  156. </div>
  157. </article>
  158. </section>
  159. </div>
  160. <footer class="footer">
  161. <div class="content has-text-centered">
  162. <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.7</a></p>
  163. <p class="sidebar-created-by">
  164. <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
  165. <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
  166. </p>
  167. </div>
  168. </footer>
  169. </div>
  170. <div id="side-nav" class="side-nav">
  171. </div>
  172. </div>
  173. <script src="scripts/app.min.js"></script>
  174. <script>PR.prettyPrint();</script>
  175. <script src="scripts/linenumber.js"> </script>
  176. </body>
  177. </html>