You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
<br>
10
10
</h1>
11
11
12
-
<h4align="center"> Reactime is a performance and debugging tool for React developers. It records a snapshot whenever a target application's state is changed and allows the user to jump to any previously recorded state. </h4>
12
+
<h4align="center"> Reactime is a performance and debugging tool for React developers <b>(compatible with Gatsy and Next.js)</b>. It records a snapshot whenever a target application's state is changed and allows the user to jump to any previously recorded state, detect the amount of renders of each component and average time of rendering.</h4>
13
13
14
14
<br>
15
15
<palign="center">
@@ -43,14 +43,14 @@
43
43
<ahref="#how-to-use">How To Use</a> • <ahref="#features">Features</a> • <ahref="https://reactime.io">Website</a> • <ahref="#read-more">Read More</a>
44
44
</p>
45
45
46
-
Currently, Reactime supports React apps using stateful components and Hooks, with beta support for Recoil and Context API.
46
+
Currently, Reactime supports React apps using stateful components and Hooks, including frameworks like Gatsby and Next.js, with beta support for Recoil and Context API.
47
47
48
48
<b>Reactime version 7.0</b> beta can help you to avoid unnecessary re-renders. Identifying wasted renders in your React applications is the perfect start to identifying most performance issues.
49
49
Reactime 7.0 fixes previous version bugs and incorporates improved visualizations for component relationships. Reactime 7.0 includes expanded [typedoc](https://typedoc.org/api/) documentation for developers looking to contribute to the source code.
50
50
51
51
After installing Reactime, you can test its functionalities with your React application in development mode.
52
52
53
-
Please note, the time jumping feature will ONLY work when your application is running in development mode. In production mode, you are able to view your application’s component map but no additional features.
53
+
Please note, the time jumping feature will <b>ONLY</b> work when your application is running in <b>development mode</b>. In production mode, you are able to view your application’s component map but no additional features.
54
54
55
55
## <b>Installation</b>
56
56
@@ -88,6 +88,12 @@ Reactime is an open source project, and we’d really appreciate your help with
88
88
89
89
One of the most common issues that affects performance in React is unnecessary render cycles. This problem can be fixed by checking your renders in the Performance tab in Chrome DevTools under the Reactime panel.
90
90
91
+
### Gatsby
92
+
Reactime offers fully support for Gatsy applications. You would be able to identify unnecessary renders, duration of each rendering, travel-debugging features and visual representation of the tree components.
93
+
94
+
### Next.js
95
+
Reactime offers debugging and performance tools for Next.js apps: time-traveling debugging, preventing unnecessary components re-renders and making your application faster.
96
+
91
97
### Recording
92
98
93
99
Whenever state is changed (whenever setState, useState is called), this extension will create a snapshot of the current state tree and record it. Each snapshot will be displayed in Chrome DevTools under the Reactime panel.
@@ -107,6 +113,11 @@ Reactime offers beta support for TypeScript applications using stateful class co
107
113
### Documentation
108
114
109
115
After cloning this repository, developers can simply run `npm run docs` at the root level and serve the dynamically generated `/docs/index.html` file on a browser. Doing so will provide a readable, extensible, and interactive GUI view of the structure and interfaces of the codebase.
0 commit comments