update navigate description

etn-ccis · Mar 7, 2024 · aa42a04 · aa42a04
1 parent 72cbd33
commit aa42a04
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/login-workflow/docs/API.md b/login-workflow/docs/API.md
@@ -10,7 +10,7 @@ The `RegistrationContextProvider` manages the state of the registration workflow
 -  **language**: _`string`_
     -   The language code to use for the registration workflow. This is used to determine which language to use for the UI and for the API calls.
 -  **navigate**: _`(destination: -1 | string) => void`_
-    -   A function that is used to navigate to a new URL. This is used to navigate to the various screens of the registration workflow.
+    -   A function that is used to navigate to a new URL. This is used to navigate to the various screens of the registration workflow and destination: -1 navigates back to the previous screen the user last visited.
 -  **routeConfig**: _`RouteConfig`_
     -   An object that defines the various routes for the registration workflow. See [RouteConfig](#routeconfig) for more information.
 -  **i18n**: (optional) _`i18n`_