@novodip/expo-router-devtools 1.0.8 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +24 -17
  3. package/package.json +1 -1
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 [Your Name]
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Novodip
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -5,6 +5,13 @@ Designed to be embedded directly into React Native apps without affecting produc
5
5
 
6
6
  ---
7
7
 
8
+ ## Demo
9
+
10
+ [![Expo Router DevTools Demo](https://raw.githubusercontent.com/Novo1999/expo-router-devtools/main/assets/devtools-thumbnail.png)](https://github.com/Novo1999/expo-router-devtools#demo)
11
+
12
+ ▶ **Watch full 34-second demo video**
13
+ https://github.com/user-attachments/assets/71dd6770-7e92-4275-9497-40b3fbbf1cae
14
+
8
15
  ## Features
9
16
 
10
17
  - View the current route in real time
@@ -16,12 +23,14 @@ Designed to be embedded directly into React Native apps without affecting produc
16
23
  ---
17
24
 
18
25
  ## Benefits
26
+
19
27
  - Useful for complex projects that has a lot of routing
20
28
  - Useful for projects with query params in many places
21
29
  - Keeps track of params and query params and save it in the history
22
30
  - Automatically hidden in production
23
31
  - Save whatever routes you want and navigate to it
24
- - Routes are automatically stored in expo secure store
32
+ - Routes are automatically stored in expo secure store
33
+
25
34
  ---
26
35
 
27
36
  ## Installation
@@ -29,6 +38,7 @@ Designed to be embedded directly into React Native apps without affecting produc
29
38
  ```bash
30
39
  npm install expo-router-devtools
31
40
  ```
41
+
32
42
  or
33
43
 
34
44
  ```bash
@@ -37,6 +47,7 @@ yarn add expo-router-devtools
37
47
  ```
38
48
 
39
49
  ## Usage
50
+
40
51
  ```bash
41
52
  import { ExpoRouterDevTools } from '@novodip/expo-router-devtools'
42
53
  import { Stack } from 'expo-router'
@@ -59,28 +70,24 @@ export default function RootLayout() {
59
70
  }
60
71
 
61
72
  ```
73
+
62
74
  ## API Reference
63
75
 
64
76
  ### Props
65
77
 
66
- | Prop | Type | Default | Description |
67
- |------|------|---------|-------------|
68
- | `position` | `'top' \| 'bottom'` | `'top'` | Position of the DevTools panel |
69
- | `theme` | `'light' \| 'dark'` | `'light'` | Color theme |
70
- | `hideInProduction` | `boolean` | `true` | Hide in production builds |
71
- | `storageKeyPrefix` | `string` | `'expo-router-devtools_'` | Prefix for SecureStore keys |
72
- | `onRouteChange` | `(route: string) => void` | `undefined` | Callback when route changes |
73
- | `enableHistory` | `boolean` | `true` | Enable route history tracking |
74
- | `maxHistory` | `number` | `10` | Maximum history items |
75
- | `maxNumOfLines` | `number` | `3` | Max lines for current route display |
78
+ | Prop | Type | Default | Description |
79
+ | ------------------ | ------------------------- | ------------------------- | ------------------------------------ |
80
+ | `position` | `'top' \| 'bottom'` | `'top'` | Position of the DevTools panel |
81
+ | `hideInProduction` | `boolean` | `true` | Hide in production builds |
82
+ | `storageKeyPrefix` | `string` | `'expo-router-devtools_'` | Prefix for SecureStore keys |
83
+ | `onRouteChange` | `(route: string) => void` | `undefined` | Callback when route changes |
84
+ | `enableHistory` | `boolean` | `true` | Enable route history tracking |
85
+ | `maxHistory` | `number` | `10` | Maximum history items |
86
+ | `maxNumOfLines` | `number` | `3` | Max lines for current route display |
87
+ | `replaceRoute` | `boolean` | `false` | Whether to replace of push the route |
76
88
 
77
89
  ### Example
78
90
 
79
91
  ```tsx
80
- <ExpoRouterDevTools
81
- position="bottom"
82
- theme="dark"
83
- maxHistory={20}
84
- onRouteChange={(route) => console.log(route)}
85
- />
92
+ <ExpoRouterDevTools position="bottom" maxHistory={20} onRouteChange={(route) => console.log(route)} />
86
93
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@novodip/expo-router-devtools",
3
- "version": "1.0.8",
3
+ "version": "1.1.2",
4
4
  "description": "Development tools for Expo Router - visualize routes, save navigation states, and debug your app's navigation flow",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.esm.js",