Skip to content

Commit 7ba84af

Browse files
committed
docs: scaffold docs structure for Performance tracks
1 parent e9a7cb1 commit 7ba84af

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed
103 KB
Loading
578 KB
Loading
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: React Performance tracks
3+
version: experimental
4+
---
5+
6+
<Experimental>
7+
8+
**This feature is experimental and is not available in a stable version of React yet.**
9+
10+
You can try it by upgrading React packages to the most recent experimental version:
11+
12+
- `react@experimental`
13+
- `react-dom@experimental`
14+
- `eslint-plugin-react-hooks@experimental`
15+
16+
Experimental versions of React may contain bugs. Don't use them in production.
17+
18+
</Experimental>
19+
20+
<Intro>
21+
22+
React Performance tracks are specialized custom entries that appear on the [Performance panel's timeline of Chrome DevTools](https://developer.chrome.com/docs/devtools/performance/overview).
23+
24+
</Intro>
25+
26+
These tracks are designed to provide developers with comprehensive insights into their React application's performance by visualizing React-specific events and metrics alongside other critical data sources such as Network requests, JavaScript execution, and Event Loop activity, all synchronized on a unified timeline within the Performance panel for a complete understanding of application behavior.
27+
28+
![React Performance tracks overview](/images/docs/react-perf-tracks-overview.png)
29+
30+
<InlineToc />
31+
32+
---
33+
34+
## Usage {/*usage*/}
35+
36+
You don't need to do anything to explicitly enable React Performance tracks. They are enabled by default in development and profiling builds of React and should appear by default in the traces you record with the Performance panel.
37+
38+
<Pitfall>
39+
40+
Profiling instrumentation that powers React Performance tracks adds some additional overhead, so it is disabled in the production build by default.
41+
42+
</Pitfall>
43+
44+
---
45+
46+
## Tracks {/*tracks*/}
47+
48+
### Scheduler {/*scheduler*/}
49+
50+
🚧 Work in progress...
51+
52+
### Components {/*components*/}
53+
54+
🚧 Work in progress...

0 commit comments

Comments
 (0)