React Compiler directives are special string literals that control whether specific functions are compiled.
functionMyComponent(){
"use memo";// Opt this component into compilation
return<div>{/* ... */}</div>;
}Overview
React Compiler directives provide fine-grained control over which functions are optimized by the compiler. They are string literals placed at the beginning of a function body or at the top of a module.
Available directives
"use memo"- Opts a function into compilation"use no memo"- Opts a function out of compilation
Quick comparison
| Directive | Purpose | When to use |
|---|---|---|
"use memo" | Force compilation | When usingannotation mode or to overrideinfer mode heuristics |
"use no memo" | Prevent compilation | Debugging issues or working with incompatible code |
Usage
Function-level directives
Place directives at the beginning of a function to control its compilation:
// Opt into compilation
functionOptimizedComponent(){
"use memo";
return<div>This will be optimized</div>;
}
// Opt out of compilation
functionUnoptimizedComponent(){
"use no memo";
return<div>This won't be optimized</div>;
}Module-level directives
Place directives at the top of a file to affect all functions in that module:
// At the very top of the file
"use memo";
// All functions in this file will be compiled
functionComponent1(){
return<div>Compiled</div>;
}
functionComponent2(){
return<div>Also compiled</div>;
}
// Can be overridden at function level
functionComponent3(){
"use no memo";// This overrides the module directive
return<div>Not compiled</div>;
}Compilation modes interaction
Directives behave differently depending on yourcompilationMode:
annotationmode: Only functions with"use memo"are compiledinfermode: Compiler decides what to compile, directives override decisionsallmode: Everything is compiled,"use no memo"can exclude specific functions
Best practices
Use directives sparingly
Directives are escape hatches. Prefer configuring the compiler at the project level:
// ✅ Good - project-wide configuration
{
plugins:[
['babel-plugin-react-compiler',{
compilationMode:'infer'
}]
]
}
// ⚠️ Use directives only when needed
functionSpecialCase(){
"use no memo";// Document why this is needed
// ...
}Document directive usage
Always explain why a directive is used:
// ✅ Good - clear explanation
functionDataGrid(){
"use no memo";// TODO: Remove after fixing issue with dynamic row heights (JIRA-123)
// Complex grid implementation
}
// ❌ Bad - no explanation
functionMystery(){
"use no memo";
// ...
}Plan for removal
Opt-out directives should be temporary:
- Add the directive with a TODO comment
- Create a tracking issue
- Fix the underlying problem
- Remove the directive
functionTemporaryWorkaround(){
"use no memo";// TODO: Remove after upgrading ThirdPartyLib to v2.0
return<ThirdPartyComponent/>;
}Common patterns
Gradual adoption
When adopting the React Compiler in a large codebase:
// Start with annotation mode
{
compilationMode:'annotation'
}
// Opt in stable components
functionStableComponent(){
"use memo";
// Well-tested component
}
// Later, switch to infer mode and opt out problematic ones
functionProblematicComponent(){
"use no memo";// Fix issues before removing
// ...
}Troubleshooting
For specific issues with directives, see the troubleshooting sections in:
Common issues
- Directive ignored: Check placement (must be first) and spelling
- Compilation still happens: Check
ignoreUseNoForgetsetting - Module directive not working: Ensure it’s before all imports
See also
compilationMode- Configure how the compiler chooses what to optimizeConfiguration- Full compiler configuration options- React Compiler documentation - Getting started guide