Skip to content
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.

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

[Property Editor] Show widget name and documentation in property list #8716

Open
elliette opened this issue Jan 14, 2025 · 0 comments
Open
Labels
analysis-server-change-needed issues that require a corresponding change to the Analysis Server P2 important to work on, but not at the top of the work list. property editor

Comments

@elliette
Copy link
Member

elliette commented Jan 14, 2025

It would be useful to show the widget's name above the list of properties in the property editor.

This requires including the name of the widget in the response sent back from the Analysis Server, e.g.:

{
   "name": "Center", // <-- widget name
   "documentation": "Creates a widget that centers its child.", // <-- documentation
    "arguments": [
      {
        "name": "widthFactor",
        "type": "double",
        "value": 10.0,
        "isDefault": false,
      },
     ...

The documentation corresponds to the short description shown when hovering on the widget name in a code editor:

Image

Note: I've also added this to the Property Editor API spec.

@elliette elliette added P2 important to work on, but not at the top of the work list. property editor analysis-server-change-needed issues that require a corresponding change to the Analysis Server labels Jan 14, 2025
@elliette elliette changed the title [Property Editor] Show widget name in property list [Property Editor] Show widget name and documentation in property list Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
analysis-server-change-needed issues that require a corresponding change to the Analysis Server P2 important to work on, but not at the top of the work list. property editor
Projects
None yet
Development

No branches or pull requests

1 participant