Skip to content

feat: add tooltip field to workspace app#435

Merged
rafrdz merged 4 commits into
mainfrom
rafrdz/tooltip-support
Sep 10, 2025
Merged

feat: add tooltip field to workspace app#435
rafrdz merged 4 commits into
mainfrom
rafrdz/tooltip-support

Conversation

@rafrdz

@rafrdz rafrdz commented Aug 29, 2025

Copy link
Copy Markdown

Summary

In this pull request we're adding an optional tooltip field. The tooltip field is a string field (with markdown support) that will be used to display tooltips on hover over app buttons in a workspace dashboard.

Tooltip screenshot

Screenshot 2025-08-29 at 4 11 56 PM

Tooltip video

tooltip-link.mov

Issue: coder/coder#18431
Related coder PR: coder/coder#19651

Changes

  • Added tooltip to the app schema with a max length of 2048 characters
  • Updated app documentation to include the tooltip field
  • Added an example tooltip

Testing

  • Added tests for empty, valid, and max length (to test validation logic)

@matifali

matifali commented Sep 3, 2025

Copy link
Copy Markdown
Member

I wonder if the markdown link in the tooltip is clickable. What happens when you move from the button to the tooltip? Does it disappear?

@rafrdz

rafrdz commented Sep 3, 2025

Copy link
Copy Markdown
Author

I wonder if the markdown link in the tooltip is clickable. What happens when you move from the button to the tooltip? Does it disappear?

@matifali Updated the PR description with a short video showing what clicking a link in the tooltip looks like. Hopefully that helps!

@matifali

matifali commented Sep 3, 2025

Copy link
Copy Markdown
Member

@rafrdz This is great. Thank you.

@matifali

matifali commented Sep 7, 2025

Copy link
Copy Markdown
Member

@rafrdz, one last thing to consider here is if someone used the latest provider with an older version of Coder, where this is not supported? Can we add a warning (or better, fail) in the provider to inform the user of the minimum required Coder version?

This warning/error should only happen if someone tries to use tooltip on an older Coder version.

If this looks like too much work, I am fine extracting that into a separate PR.

@rafrdz

rafrdz commented Sep 9, 2025

Copy link
Copy Markdown
Author

@rafrdz, one last thing to consider here is if someone used the latest provider with an older version of Coder, where this is not supported? Can we add a warning (or better, fail) in the provider to inform the user of the minimum required Coder version?

This warning/error should only happen if someone tries to use tooltip on an older Coder version.

If this looks like too much work, I am fine extracting that into a separate PR.

@matifali Took a look and discussed this with others. Sounds like it'll be a bit of work so going to create an issue for this.

@rafrdz rafrdz merged commit bb2167e into main Sep 10, 2025
6 checks passed
@rafrdz rafrdz deleted the rafrdz/tooltip-support branch September 10, 2025 14:55
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 10, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants