@novodip/expo-router-devtools 1.1.1 → 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 (2) hide show
  1. package/README.md +23 -19
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,8 +4,14 @@ A lightweight development utility for inspecting and debugging routes in **Expo
4
4
  Designed to be embedded directly into React Native apps without affecting production builds.
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**
8
13
  https://github.com/user-attachments/assets/71dd6770-7e92-4275-9497-40b3fbbf1cae
14
+
9
15
  ## Features
10
16
 
11
17
  - View the current route in real time
@@ -17,21 +23,22 @@ https://github.com/user-attachments/assets/71dd6770-7e92-4275-9497-40b3fbbf1cae
17
23
  ---
18
24
 
19
25
  ## Benefits
26
+
20
27
  - Useful for complex projects that has a lot of routing
21
28
  - Useful for projects with query params in many places
22
29
  - Keeps track of params and query params and save it in the history
23
30
  - Automatically hidden in production
24
31
  - Save whatever routes you want and navigate to it
25
- - Routes are automatically stored in expo secure store
26
- ---
27
-
32
+ - Routes are automatically stored in expo secure store
28
33
 
34
+ ---
29
35
 
30
36
  ## Installation
31
37
 
32
38
  ```bash
33
39
  npm install expo-router-devtools
34
40
  ```
41
+
35
42
  or
36
43
 
37
44
  ```bash
@@ -40,6 +47,7 @@ yarn add expo-router-devtools
40
47
  ```
41
48
 
42
49
  ## Usage
50
+
43
51
  ```bash
44
52
  import { ExpoRouterDevTools } from '@novodip/expo-router-devtools'
45
53
  import { Stack } from 'expo-router'
@@ -62,28 +70,24 @@ export default function RootLayout() {
62
70
  }
63
71
 
64
72
  ```
73
+
65
74
  ## API Reference
66
75
 
67
76
  ### Props
68
77
 
69
- | Prop | Type | Default | Description |
70
- |------|------|---------|-------------|
71
- | `position` | `'top' \| 'bottom'` | `'top'` | Position of the DevTools panel |
72
- | `hideInProduction` | `boolean` | `true` | Hide in production builds |
73
- | `storageKeyPrefix` | `string` | `'expo-router-devtools_'` | Prefix for SecureStore keys |
74
- | `onRouteChange` | `(route: string) => void` | `undefined` | Callback when route changes |
75
- | `enableHistory` | `boolean` | `true` | Enable route history tracking |
76
- | `maxHistory` | `number` | `10` | Maximum history items |
77
- | `maxNumOfLines` | `number` | `3` | Max lines for current route display |
78
- | `replaceRoute` | `boolean` | `false` | Whether to replace of push the route |
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 |
79
88
 
80
89
  ### Example
81
90
 
82
91
  ```tsx
83
- <ExpoRouterDevTools
84
- position="bottom"
85
- maxHistory={20}
86
- onRouteChange={(route) => console.log(route)}
87
- />
92
+ <ExpoRouterDevTools position="bottom" maxHistory={20} onRouteChange={(route) => console.log(route)} />
88
93
  ```
89
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@novodip/expo-router-devtools",
3
- "version": "1.1.1",
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",