stride3d / stride3d/stride

Property Grid Summary Area, user experience suggestions.

Open
#2,430 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C#
Stars
7.8k
Forks
1.2k
Avg merge
2d 17h
Merged PRs (30d)
49

Description

Describe the solution you'd like
The Property Grid displays the property name and its corresponding type in the Summary area when hovering over on an item.

Proposed Enhancements:

  • Summary on Selection: Instead of displaying the property information on mouse hover, synchronize the Summary area with the property header selection. This to provide a better readability in case of unintentional mouse interaction. It would also enable the next point.

  • Selectable Summary text: it would be useful in some cases to be able to copy the text in the summary, in particular property and type name.

  • Enhanced Layout for Summary Area: The current layout of the Summary area should be restructured to display property information across three distinct lines (see mockup):
    Line 1: Property name (Title)
    Line 2: Property type
    Line 3: Documentation string (a short description or explanation of the property)
    The reason for this is that presently the property name is left aligned and the type name is right aligned and has a variable length, and as already mentioned, changes on mouse hover create lot of visual noise and make more difficult to read the info. Having all the text left aligned would avoid to eye search the info.

  • Automatic Documentation Generation: Implement automatic generation of the documentation string for properties. This ensures that any updates or changes made to properties will be reflected in the documentation section without manual updates.

  • Enum and Multi-Choice Properties: For properties that are enums or have multiple selectable values, display these options in the documentation section. This will provide users with an immediate understanding of the available choices without having to interact with the property directly. Also this section should be generated automatically if possible.

I think user can benefit from these changes in terms of productivity.

StridePropertyGridInfo

image

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. First locate the Property Grid implementation and clarify which of the proposed summary, selection, documentation, and enum-display changes is in scope. Done should be defined as an agreed subset implemented with validation for the affected editor behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
design, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.