apps
/
atlas-mobile-ts


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709
							<!DOCTYPE html>
<html lang="en">

<head>
  
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title> RegisterMain</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>Components</p>
                    <h1>RegisterMain</h1>
                </header>
                

<section>

<header>
    
        <h2>
            &ltRegisterMain  /&gt
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
            <div class='vertical-section'>
                <div class="members">
                    <div class="member">
                        <div class=name>
                            <span class="tag">Constructor</span>
                        </div>
                        

    <h4 class="name" id="RegisterMain">
        <a class="href-link" href="#RegisterMain">#</a>
        
        <span class="code-name">
            
                &ltRegisterMain  /&gt
            
        </span>
    </h4>
    

    <div class="description">
        <p>The main registration component. Acts as a backdrop for all intermediate registration steps.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_Auth_Registration_RegisterMain.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_Auth_Registration_RegisterMain.tsx.html">src/components/Auth/Registration/RegisterMain.tsx</a>, <a href="src_components_Auth_Registration_RegisterMain.tsx.html#line18">line 18</a>
            </span>
        </p>
    
</dl>


                    </div>
                </div>
            </div>
        
    
    </div>
    
        
        <div class='vertical-section'>
            <h1>Members</h1>
            <div class="members">
            
                <div class="member">

<h4 class="name" id=".preventExitFromRegistration">
    <a class="href-link" href="#.preventExitFromRegistration">#</a>
    
        
            <span class='tag'>static</span>
        
            <span class='tag'>constant</span>
        
    
    <span class="code-name">
        preventExitFromRegistration
    </span>
    
</h4>


<div class="description">
    <p>Handler that intercepts a request to leave the registration screen and asks the user to confirm that they want to leave.
If they confirm they want to leave, all registration state will reset and the user will be directed back to <a href="Intro.html">Intro</a>.</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_Auth_Registration_RegisterMain.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_Auth_Registration_RegisterMain.tsx.html">src/components/Auth/Registration/RegisterMain.tsx</a>, <a href="src_components_Auth_Registration_RegisterMain.tsx.html#line41">line 41</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id="~stepState">
    <a class="href-link" href="#~stepState">#</a>
    
        
            <span class='tag'>inner</span>
        
            <span class='tag'>constant</span>
        
    
    <span class="code-name">
        stepState
    </span>
    
</h4>


<div class="description">
    <p>Holds an integer value that maps to a step in the registration process.
The mapping is as follows:</p>
<ul>
<li>1 -&gt; Username and Email</li>
<li>2 -&gt; Password</li>
<li>3 -&gt; Sagitta and Measurements</li>
<li>4 -&gt; Profile picture and submission</li>
<li>5 -&gt; Result</li>
</ul>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_Auth_Registration_RegisterMain.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_Auth_Registration_RegisterMain.tsx.html">src/components/Auth/Registration/RegisterMain.tsx</a>, <a href="src_components_Auth_Registration_RegisterMain.tsx.html#line27">line 27</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id="~subTitleState">
    <a class="href-link" href="#~subTitleState">#</a>
    
        
            <span class='tag'>inner</span>
        
            <span class='tag'>constant</span>
        
    
    <span class="code-name">
        subTitleState
    </span>
    
</h4>


<div class="description">
    <p>Holds the current subtitle text.</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_Auth_Registration_RegisterMain.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_Auth_Registration_RegisterMain.tsx.html">src/components/Auth/Registration/RegisterMain.tsx</a>, <a href="src_components_Auth_Registration_RegisterMain.tsx.html#line32">line 32</a>
            </span>
        </p>
    
</dl>


</div>
            
            </div>
        </div>
    

        <div class='vertical-section'>
            <h1>Methods</h1>
            <div class="members">
            
                <div class="member">


    <h4 class="name" id="~changeStep">
        <a class="href-link" href="#~changeStep">#</a>
        
            
                <span class='tag'>inner</span>
            
        
        <span class="code-name">
            
                changeStep<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Changes the registration step to the given value.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_Auth_Registration_RegisterMain.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_Auth_Registration_RegisterMain.tsx.html">src/components/Auth/Registration/RegisterMain.tsx</a>, <a href="src_components_Auth_Registration_RegisterMain.tsx.html#line62">line 62</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">


    <h4 class="name" id="~finish">
        <a class="href-link" href="#~finish">#</a>
        
            
                <span class='tag'>inner</span>
            
        
        <span class="code-name">
            
                finish<span class="signature">()</span><span class="type-signature"></span>
            
        </span>
    </h4>
    

    <div class="description">
        <p>Returns to the intro screen.</p>
    </div>
    

<dl class="details">

    
        <p class="tag-source">
            <a href="src_components_Auth_Registration_RegisterMain.tsx.html" class="button">View Source</a>
            <span>
                <a href="src_components_Auth_Registration_RegisterMain.tsx.html">src/components/Auth/Registration/RegisterMain.tsx</a>, <a href="src_components_Auth_Registration_RegisterMain.tsx.html#line69">line 69</a>
            </span>
        </p>
    
</dl>


</div>
            
            </div>
        </div>
    

</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>