Skip to content

Add Optional Tooltip Support for coder_app Buttons #18431

@matifali

Description

@matifali

Problem Description

Currently, coder_app resources do not support displaying tooltips, preventing template authors from providing contextual information. Users often don't understand what an app does before clicking, resulting in confusion and support requests.

Desired Solution

Add a tooltip field to coder_app Terraform resources with Markdown rendering (bold, italic, links). Display the tooltip on hover over app buttons in the workspace dashboard.

Example Usage

resource "coder_app" "rdp-coder-desktop" {
  agent_id     = coder_agent.main.id
  slug         = "rdp-desktop"
  display_name = "RDP with Coder Desktop"
  url          = "coder://dev.coder.com/v0/open/ws/${data.coder_workspace.me.name}/agent/main/rdp?username=Administrator&password=coderRDP!"
  icon         = "/icon/desktop.svg"
  external     = true
+ tooltip      = "You need to [Install Coder Desktop](https://coder.com/docs/user-guides/desktop#install-coder-desktop) to use this button." # markdown supported field
}

Implementation Requirements

  • Terraform Provider

    • Add optional tooltip string to app schema in /provider/app.go
    • Validate max length (512 characters)
    • Update provider documentation with Markdown examples
  • Backend

    • Add Tooltip string to WorkspaceApp struct in /codersdk/workspaceapps.go
    • Update DB schema and API to include tooltip
  • Frontend

    • Update AppLink.tsx to show tooltips on hover
    • Render Markdown (support bold, italic, [links](url))
    • Apply to both grouped and ungrouped buttons
  • Documentation

    • Add tooltip field explanation and usage examples with Markdown

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions