Skip to content

Replace help buttons and version in the help footer with the ones provided by Grafana #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 20 commits into from
Oct 22, 2025
Merged

Replace help buttons and version in the help footer with the ones provided by Grafana #228

merged 20 commits into from
Oct 22, 2025

Conversation

jdbaldry
Copy link
Collaborator

@jdbaldry jdbaldry commented Oct 14, 2025 •
edited
Loading

Before (in Ops):

  • Uses static buttons bundled in the plugin
  • Renders a fake modal for keyboard shortcuts
  • Uses an approximate version string which differs from the one rendered for users in Grafana Cloud
  • Uses non-standard link button components with modified hover behavior
Screenshot 2025-10-14 at 16 41 32

After (local dev):

  • Renders the help menu items provided by Grafana
  • Renders the full keyboard shortcuts modal
  • Uses the help menu version string
  • Uses standard Grafana LinkButton components
Screenshot 2025-10-14 at 16 45 25

Closes #221

@jdbaldry
Render links and version info from the enriched help node provided by…
4f761e7 
… Grafana

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fix memoization of the context panel
aabb297 
It wasn't actually memoized.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Use Grafana LinkButtons instead of our own button component
dc83e2b 
Closes #221

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry requested review from a team, Jayclifford345 and tomglenn as code owners October 14, 2025 15:46
@jdbaldry
Copy link
Collaborator Author

I need to work out how I can satisfy the @grafana/scenes runtime dependency. Will take a look and see if there's some guidance on that in the scenes source.

jdbaldry and others added 14 commits October 17, 2025 11:06
@jdbaldry
Merge remote-tracking branch 'origin/main' into jdb/2025-10-help-menu-3
9b41e18 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Update runtime version and package lock
1f76604 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Skip peer dependency checks
fa24418 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Prettier
6455f38 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
fixup! Skip peer dependency checks
5e18343 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@Jayclifford345
Merge branch 'main' into jdb/2025-10-help-menu-3
f46a279
@jdbaldry
Support backwards compatibility
1632a01 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Fix dependency conflicts
2ce2c83 
Because NPM auto installs peer dependencies by default, we can rely on the `@grafana/scenes` peer dependency on `@grafana/runtime` to install the package.

The override declares the version your project needs which is the canary release to support the `useHelpNavItem` function.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Revert "Skip peer dependency checks"
2a73845 
This reverts commit fa24418.
@jdbaldry
Revert "fixup! Skip peer dependency checks"
ddde450 
This reverts commit 5e18343.
@jdbaldry
fixup! Fix dependency conflicts
a9a97a3 
Because NPM auto installs peer dependencies by default, we can rely on the `@grafana/scenes` peer dependency on `@grafana/runtime` to install the package.

The override declares the version your project needs which is the canary release to support the `useHelpNavItem` function.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Call hooks unconditionally
d1faabe 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
fixup! Call hooks unconditionally
a61a6f8 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
fixup! Call hooks unconditionally
3bf9cf6 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry jdbaldry force-pushed the jdb/2025-10-help-menu-3 branch from 89eb7b6 to 3bf9cf6 Compare October 20, 2025 13:32
@jdbaldry
Ignore eslint
b2a9e43 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Revert "Support backwards compatibility"
bbe36c4 
This reverts commit 1632a01.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@jdbaldry
Bump minimum required version
a745880 
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
@github-actions
Copy link
Contributor

Playwright test results

Image Name Version Result Report
grafana-dev 12.3.0-18680731792 ✅

⚠️ To make Playwright reports for failed tests publicly accessible on GitHub Pages, set the upload-report input to true in your CI workflow. For more details, refer to the Developer Portal documentation.

@Jayclifford345 Jayclifford345 merged commit 12f6bbc into main Oct 22, 2025
11 checks passed
@Jayclifford345 Jayclifford345 deleted the jdb/2025-10-help-menu-3 branch October 22, 2025 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Jayclifford345 Jayclifford345 Awaiting requested review from Jayclifford345 Jayclifford345 is a code owner

@tomglenn tomglenn Awaiting requested review from tomglenn tomglenn is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Bug: Non standard link buttons

2 participants

@jdbaldry @Jayclifford345