Merge pull request #376 from chiefcll/fix-backtrack-docs

fix #375 - update docs for backtracking

Author: uguraslan

docs/plugins/router/deeplinking.md

@@ -9,13 +9,13 @@ Deeplinking is an important feature, because:
 * Regular data providing for a specific route is still executed.
 * The configuration object's [boot](configuration.md#boot) key handles any general operations to be executed for a proper functioning of your App.
 
-## Backtracking
+## Backtrack
 
 When a user enters your App via a deeplink, there is technically *no* history available. By default, this would mean that a **Back** key press leads to exiting the App.
 
-On some platforms, this is not the desired behavior. For that reason, the Router plugin supports the *[backtracking](settings.md#backtracking)* functionality.
+On some platforms, this is not the desired behavior. For that reason, the Router plugin supports the *[backtrack](settings.md#backtrack)* functionality.
 
-When this feature is enabled (via the Platform Setting  `Router.backtracking`) and the **Back** key is pressed, the Router will *recursively* remove the last part of the hash, until it finds a valid path to navigate to.
+When this feature is enabled (via the Platform Setting  `Router.backtrack`) and the **Back** key is pressed, the Router will *recursively* remove the last part of the hash, until it finds a valid path to navigate to.
 
 #### NEXT:
 [History](history.md)

docs/plugins/router/settings.md

@@ -18,7 +18,7 @@ For example:
           "lazyCreate": true,
           "lazyDestroy": true,
           "gcOnUnload": true,
-          "backtracking": true,
+          "backtrack": true,
           "reuseInstance": false,
           "destroyOnHistoryBack": false
         }
@@ -44,9 +44,9 @@ By default, Lazy Destroy is *disabled*. This results in faster navigating back t
 
 If you want to free up texture memory *directly* after a previous page has been destroyed and you do not want to wait for Lightning's (texture) garbage collection, you can set `gcOnUnload` to `true`. This forces a texture garbage collect directly after destroying the page.
 
-### backtracking
+### backtrack
 
-If you want to enable *backtracking* in your app, you set `backtracking` to `true`.
+If you want to enable *backtracking* in your app, you set `backtrack` to `true`.
 
 ### destroyOnHistoryBack
 

src/Router/index.d.ts

@@ -62,12 +62,12 @@ export interface RouterPlatformSettings {
    *
    * @remarks
    * See [Router Settings](https://lightningjs.io/docs/#/lightning-sdk-reference/plugins/router/settings?id=router-settings)
-   * and [Deeplinking - Backtracking](https://lightningjs.io/docs/#/lightning-sdk-reference/plugins/router/deeplinking?id=backtracking)
+   * and [Deeplinking - Backtrack](https://lightningjs.io/docs/#/lightning-sdk-reference/plugins/router/deeplinking?id=backtrack)
    * for more information.
    *
    * @defaultValue `false`
    */
-  backtracking?: boolean;
+  backtrack?: boolean;
 
   /**
    * If set to `true` (default), a navigation to a hash with the same route blueprint as the current hash will cause the