Docs: Document group property for link extensions#2491
Merged
Conversation
Updates documentation to introduce the new `group` property that replaces the deprecated `category` property on link extensions in Grafana 13. Includes migration guidance with code examples and updates to the UI extensions reference table. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Contributor
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the new group property for link UI extensions in Grafana 13 and provides migration guidance for plugin developers transitioning from the deprecated category property.
Changes:
- Updates the UI extensions reference to mark
categoryas deprecated and document the newgroupobject shape. - Adds a Grafana 12.x → 13.x migration guide section explaining how to migrate from
categorytogroup, including examples. - Updates the UI extensions how-to guide example comments to include
groupand flagcategoryas deprecated.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docusaurus/docs/reference/ui-extensions-reference/ui-extensions.md | Updates the addLink() config reference table to deprecate category and add group. |
| docusaurus/docs/migration-guides/update-from-grafana-versions/v12.x-v13.x.md | Adds migration guidance and examples for moving from category to group. |
| docusaurus/docs/how-to-guides/ui-extensions/register-an-extension.md | Updates inline guidance/comments to reflect category deprecation and introduce group. |
docusaurus/docs/migration-guides/update-from-grafana-versions/v12.x-v13.x.md
Show resolved
Hide resolved
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
tolzhabayev
pushed a commit
that referenced
this pull request
Feb 27, 2026
Co-authored-by: Claude Haiku 4.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
groupproperty that replaces the deprecatedcategoryproperty on link extensions in Grafana 13. Includes comprehensive migration guidance with code examples and updates the UI extensions reference table.What this PR does / why we need it
The
groupproperty provides improved control over how links are grouped and displayed in the UI, offering optional icon support compared to the string-basedcategoryproperty. This PR documents the migration path for plugin developers.Related to: grafana/grafana#116481
Which issue(s) this PR fixes
Fixes #
Special notes for your reviewer
categoryproperty continues to work (backward compatibility) but will be removed in a future Grafana versionconfigure()callbackcategoryas deprecated and document the newgroupproperty