Skip to content

Changelog: Add documentation hovers to dashboard widget properties #1526

@ellipsis-dev

Description

@ellipsis-dev

Summary

A new feature has been merged into the main langfuse repository that adds hover documentation to widget properties in the dashboard. This enhancement improves the user experience by providing in-context descriptions, types, and units for views, metrics, and dimensions when configuring dashboard widgets.

Details

  • Feature: Adds hover documentation to widget properties (views, metrics, dimensions) in the dashboard's widget configuration form.
  • UI/UX: Introduces a new WidgetPropertySelectItem component that displays a hover card with property details (description, type, unit) for each selectable item.
  • Data Model:
    • Adds description, type, and unit fields to dimensions and measures in the data model (dataModel.ts, types.ts).
    • Updates view declarations to include descriptions.
  • Affected Files:
    • web/src/features/query/dataModel.ts
    • web/src/features/query/types.ts
    • web/src/features/widgets/components/WidgetForm.tsx
    • web/src/features/widgets/components/WidgetPropertySelectItem.tsx (new)
    • web/src/features/query/server/queryBuilder.ts
  • User Impact:
    • Users can now hover over widget property options to see helpful documentation, making it easier to understand the available data fields and configure widgets accurately.

Reference


This changelog post is created in accordance with changelog post guidelines.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions