React 19 Plugin Migration
Grafana LabsOfficialPublished by Grafana Labs
- Skill
- Workflow
- Cloud and DevOps
- Apache-2.0
- Low risk
AutoGineer summary
Written by AutoGineer from the skill’s own files, not by the author
This skill provides a structured procedure for updating Grafana plugins to ensure compatibility with React 19, which is introduced in Grafana 13. It covers environment detection, scaffolding updates via create-plugin, dependency management, and source code adjustments. The process emphasizes maintaining forward compatibility without upgrading the local React version, ensuring the plugin remains stable within the Grafana ecosystem.
What it does
- Detects plugin environment and configuration
- Updates scaffolding using @grafana/create-plugin
- Externalizes jsx-runtime to prevent runtime crashes
- Bumps core Grafana and Faro dependencies
- Provides manual fixes for deprecated React patterns
- Offers troubleshooting steps for common migration errors
When to use it
- When preparing a Grafana plugin for the Grafana 13 release
- When encountering React 19 compatibility issues
- When needing to bump grafanaDependency to 12.3.0
- When resolving ReactCurrentOwner or ReactCurrentDispatcher errors
Advantages
- Ensures plugin stability in the upcoming Grafana 13 environment
- Standardizes the migration process across different plugin types
- Provides clear paths for resolving common dependency and build errors
- Includes specific guidance for complex issues like i18n initialization
Usage examples
- “How do I update my plugin for React 19?”
- The agent will initiate the migration workflow, starting with environment detection and scanning for compatibility issues.
- “My plugin crashes with ReactCurrentOwner error, what should I do?”
- The agent will guide you through bumping @grafana-cloud dependencies and externalizing jsx-runtime to resolve the crash.
Install
Download the skill as a ZIP:
https://autogineer.com/agent-skills/grafana/react-19-plugin-migration/downloadUnzip it into the cross-client skills folder of your project:
mkdir -p .agents/skills && unzip react-19-plugin-migration.zip -d .agents/skills
Documentation by Grafana Labs
Migrate Grafana Plugin to React 19
Grafana 13 (April 2026) moves from React 18 to React 19. Incompatible plugins will break. Do not upgrade React to 19 — only make forward-compatible changes.
All changes go in one PR. Execute steps in order. Never manually edit yarn.lock.
Step 1: Detect plugin context
PLUGIN_JSON=$([ -f src/plugin.json ] && echo "src/plugin.json" \
|| ([ -f plugin/src/plugin.json ] && echo "plugin/src/plugin.json" || echo ""))
PKG_JSON=$([ -f package.json ] && echo "package.json" \
|| ([ -f plugin/package.json ] && echo "plugin/package.json" || echo ""))
PLUGIN_ID=$(jq -r '.id' $PLUGIN_JSON 2>/dev/null)
[ -f yarn.lock ] && PM="yarn" || ([ -f pnpm-lock.yaml ] && PM="pnpm" || PM="npm")
CP_VERSION=$(jq -r '.version' .config/.cprc.json 2>/dev/null)
echo "PLUGIN_ID=$PLUGIN_ID PM=$PM CP=$CP_VERSION"If PLUGIN_ID is empty, ask the user for the plugin root path.
Step 2: Scan for compatibility issues
Build the plugin and run the React 19 compatibility scanner:
npm run build 2>&1 | tail -5
npx -y @grafana/react-detect@latest 2>&1Save the output. It flags:
jsxRuntimeImport/__SECRET_INTERNALS→ Step 4 fixes thisdefaultProps/propTypes/ReactDOM.render→ Step 8 (source fixes)findDOMNode→ Step 6 (dependency bump) or Step 8 (source fix)
If the build fails (plugin hasn't been built before), skip this step and run react-detect after Step 9 instead. If output says "No breaking changes detected", still proceed — jsx-runtime externalization and grafanaDependency bump are always required.
Re-run react-detect after Step 9 to confirm all issues are resolved.
Step 3: Update @grafana/create-plugin
The scaffolding update brings in externals extraction, jest mocks, Docker fixes, and webpack
improvements needed for React 19. Always do this before add externalize-jsx-runtime.
Requires a clean git working tree. Create a feature branch first if not already on one.
Run the update
npx @grafana/create-plugin@latest update 2>&1If yarn install fails with "engine is incompatible"
The update runs an intermediate yarn install without --ignore-engines. Complete it manually:
yarn install --ignore-scripts --ignore-engines 2>&1 | tail -10Commit the intermediate state and re-run:
git add -A && git commit -m "chore: intermediate create-plugin update" --no-verify
npx @grafana/create-plugin@latest update 2>&1If ESLint 9 migration (004) fails with a parser error
The auto-migration can generate invalid JS on plugins with complex ESLint configs. Do not skip — commit what succeeded, then complete the ESLint 9 migration manually:
git add -A && git commit -m "chore: update create-plugin (ESLint 9 migration manual)" --no-verifyThen follow the "Complete ESLint 9 migration" section below to finish.
After the update
Always run install and verify:
yarn install --ignore-scripts --ignore-engines 2>&1 | tail -10
cat .config/.cprc.jsonCommit if there are changes:
git add -A && git diff --cached --quiet || git commit -m "chore: update create-plugin scaffolding" --no-verifyStep 3b: Complete ESLint 9 migration
The create-plugin update bumps ESLint to v9, which requires flat config (eslint.config.js)
instead of .eslintrc. Whether the auto-migration (004) succeeded, partially succeeded, or
failed, you must ensure ESLint works before proceeding.
Check the current state
ls eslint.config.js .eslintrc* .config/.eslintrc* 2>/dev/null
npx eslint --version 2>&1Three scenarios:
A) eslint.config.js exists and yarn lint passes — auto-migration succeeded. Proceed.
B) eslint.config.js exists but yarn lint fails — partial migration. Fix the issues:
yarn lint 2>&1 | head -30Common fixes:
Invalid option '--ignore-path'orInvalid option '--ext'→ remove those flags from thelintscript inpackage.json. In ESLint v9 flat config, ignores and file matching are configured insideeslint.config.js, not via CLI flags. Update to:eslint --cache .Cannot find module 'eslint-plugin-deprecation'→ remove the import/reference fromeslint.config.js(replaced by@typescript-eslint/no-deprecated)Other dead plugin imports → remove them from the config if the package was removed
C) No eslint.config.js exists — auto-migration failed. Create one manually:
ls node_modules/@grafana/eslint-config/flat.js 2>/dev/nullIf flat.js exists, create eslint.config.js using it as the base:
import grafanaConfig from '@grafana/eslint-config/flat';
export default [
...grafanaConfig,
{
ignores: ['**/dist/', '**/node_modules/', '**/.config/', '**/coverage/'],
},
];Then migrate any custom rules from the old .eslintrc into additional config objects in the array.
After creating the flat config:
Update the
lintscript:"lint": "eslint --cache ."Delete the root
.eslintrc(leave.config/.eslintrc— it's scaffolded and harmless)
Verify lint works
yarn lint 2>&1 | tail -20Fix auto-fixable issues with yarn lint --fix. Commit:
git add -A && git diff --cached --quiet || git commit -m "chore: complete ESLint 9 flat config migration" --no-verifyStep 4: Externalize jsx-runtime
Always use the create-plugin add command. Requires a clean git working tree.
npx @grafana/create-plugin@latest add externalize-jsx-runtime 2>&1Verify:
grep "jsx-runtime" .config/bundler/externals.ts 2>/dev/nullFound → commit and proceed.
Not found → command failed. Only then add externals manually to the root
webpack.config.ts:
externals: ['react/jsx-runtime', 'react/jsx-dev-runtime'],Commit:
git add -A && git diff --cached --quiet || git commit -m "feat: externalize jsx-runtime" --no-verifyStep 5: Bump grafanaDependency
jq -r '.dependencies.grafanaDependency' $PLUGIN_JSONIf not already >=12.3.0, update it. The create-plugin add in Step 3 may have already done this.
Step 6: Bump dependencies
Faro (if present)
grep '"@grafana/faro' $PKG_JSON| Package | Target |
|---|---|
@grafana/faro-react | ^2.2.3 |
@grafana/faro-web-sdk | ^2.2.3 |
@grafana/faro-web-tracing | ^2.0.0 |
Grafana packages
grep '"@grafana/' $PKG_JSON | grep -v faro | grep -v create-pluginBump @grafana/data, @grafana/runtime, @grafana/schema, @grafana/ui to ^12.2.0 or later.
Add @grafana/i18n@^12.2.0 if the plugin uses translations or @grafana/scenes requires it.
React types
Bump react and react-dom to ^18.3.0 (surfaces React 19 issues early).
Add @types/react@^18.3.0 and @types/react-dom@^18.3.0 to devDependencies if missing.
Remove deprecated packages
Remove from devDependencies if present:
eslint-plugin-deprecation(replaced by@typescript-eslint/no-deprecated)@types/testing-library__jest-dom(replaced bysetupTests.d.ts)
Broken transitive dependencies
If yarn install fails with a stale git reference, do not edit yarn.lock. Add a resolutions entry:
"resolutions": {
"<package-name>": "<working-version-or-git-ref>"
}Then delete yarn.lock and node_modules and reinstall:
rm -rf node_modules yarn.lock
yarn install --ignore-engines 2>&1 | tail -10Step 7: Fix unmet @openfeature/web-sdk peer dependency
@grafana/runtime depends on @openfeature/react-sdk which has @openfeature/web-sdk as a
peer dependency. Yarn v1 (classic) does not auto-install peer deps.
Check if the plugin uses yarn classic:
yarn --version 2>&1 | head -1If version starts with 1., check for warnings:
yarn install --ignore-engines 2>&1 | grep "unmet peer dependency.*openfeature/web-sdk"If warnings are found:
yarn add -D @openfeature/web-sdk @openfeature/core --ignore-enginesSkip condition: Yarn v2+ or npm v7+ (peer deps are auto-installed).
Step 8: Fix source code issues
grep -rn "ReactDOM\.render\|ReactDOM\.unmountComponentAtNode\|ReactDOM\.findDOMNode" src/ --include="*.tsx" --include="*.ts"
grep -rn "\.defaultProps\s*=" src/ --include="*.tsx" --include="*.ts"
grep -rn "\.propTypes\s*=" src/ --include="*.tsx" --include="*.ts"
grep -rn "contextTypes\|getChildContext" src/ --include="*.tsx" --include="*.ts"
grep -rn "createFactory" src/ --include="*.tsx" --include="*.ts"
grep -rn "ChangeEvent<HTMLInputElement>" src/ --include="*.tsx" --include="*.ts"| Pattern | Fix |
|---|---|
ReactDOM.render() | createRoot(container).render(element) |
defaultProps on function components | Move to destructured parameter defaults |
defaultProps on class components | Leave — still works |
propTypes | Remove |
contextTypes / getChildContext | Use React.createContext() + useContext() |
createFactory | Use JSX or createElement() |
ChangeEvent<HTMLInputElement> on checkbox | Change to FormEvent<HTMLInputElement> |
Step 9: Build, typecheck, test
rm -rf node_modules dist
yarn install --ignore-engines 2>&1 | tail -10
yarn build 2>&1 | tail -10
yarn typecheck 2>&1 | tail -10
yarn test --watchAll=false 2>&1 | tail -10| Error | Fix |
|---|---|
Cannot find module 'react/jsx-runtime' | Step 4 not applied — re-run create-plugin add |
Cannot find module '@openfeature/web-sdk' | Step 7 — yarn add -D @openfeature/web-sdk @openfeature/core |
Can't resolve '@grafana/i18n' | yarn add @grafana/i18n@^12.2.0 |
Cannot read properties of undefined (reading 'ReactCurrentOwner') | Bump @grafana-cloud/* packages — see Step 6 |
aria-label is missing on icon-only Button | Add aria-label prop (newer @grafana/ui requires it) |
Stale git hash in yarn.lock | Add resolutions in package.json, delete lockfile, reinstall |
For detailed known issues (i18n crash, @grafana/schema type breaks, publicPath mismatch), see
references/known-issues.md.
Step 10: Update CI (if applicable)
grep -rn "plugin-ci-workflows\|e2e-version" .github/workflows/ 2>/dev/nullplugin-ci-workflows@mainor >= 6.0.0 → already tests React 19. No changes needed.plugin-actions/e2e-version→ addskip-grafana-react-19-preview-image: false.Neither found → test manually with
GRAFANA_VERSION=dev-preview-react19 docker compose up --build.
Step 11: Squash and push
git reset --soft origin/main
git add -A
git commit -m "fix: Prepare plugin for React 19 compatibility"Commit message body should list: create-plugin version change, ESLint 9 migration, key dependency bumps, and any source code fixes.
References
grafana-collector-app #1337 — full migration with create-plugin update + source fixes
grafana/scenes issues — upstream i18n tracking
Files
- ATTRIBUTION.mdAdded by AutoGineer873 B
- LICENSELicence file added by AutoGineer11.1 KiB
- SKILL.md11.9 KiB
- references/known-issues.md4.6 KiB
LICENSE
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2026 Grafana Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Requirements and compatibility
Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta
“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.
Needs: Needs a command-line tool, Needs Node.js
Security
What our scanner noticed· Low risk
- Instructions that use the network
A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.
Attribution and licence
- Published by
- Grafana Labs
- Publisher
- Grafana Labs (Official)
- Source
- grafana/skills · skills/grafana-plugins/react-19-plugin-migration · commit 8fb72a5
- Licence
- Apache License 2.0 (redistribution allowed)
- LICENSE (added by AutoGineer from LICENSE)
- ATTRIBUTION.md (written by AutoGineer)
- Synced
AutoGineer is not affiliated with or endorsed by Grafana Labs or Grafana Labs.
Download ZIP
The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download react-19-plugin-migration.zip