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

ListItem 2.0 (part 3): PropertyContent column auto-sizing #6182

Merged
merged 2 commits into from
May 2, 2024

Conversation

abey79
Copy link
Member

@abey79 abey79 commented May 1, 2024

What

This PR:

  • Implements column auto-sizing for PropertyContent. The current heuristics is rather simple and will likely need improvement when it's battle tested. Currently, the content requests a minimum width of 200px (there really isn't a way to properly deal with two-column-plus-button neatly all the way to 0 width), and allocate a maximum of 70% of the available width to the label column.
  • Improves the way ListItem handles content capturing the hover state (which happen for interactive content). There is no longer a requirement for ListItemContent::ui() to return an Option<Response>, which simplifies a bunch of things.
  • Updates re_ui_example accordingly

Note: still no change applied to the actual viewer code base so far.

image

Limitations and todo

  • Improved heuristics for column sizing, when we have a better idea of the need.
  • More helpers are needed for various kinds of values.
  • There can be only 0 or 1 action button. This should be extended by using a button with some kind of popup with all available actions in a future PR.
  • Right gutter space is reserved for the action button even if no list item in scope use them. The list_item_scope could track this and skip reserving that space if it's never used (e.g. component list in entity path selection panel): PropertyContent: do not allocate space for acton button if no action button is ever used in the scope #6179

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

To run all checks from main, comment on the PR with @rerun-bot full-check.

crates/re_ui/src/list_item2/scope.rs Show resolved Hide resolved
crates/re_ui/src/list_item2/scope.rs Show resolved Hide resolved
Comment on lines +33 to +36
/// Maximum desired column width, to be updated this frame.
///
/// The semantics are exactly the same as for `left_column_width`.
max_desired_left_column_width: f32,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this every shrink, or does it only ever grow?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's reset to -inf each frame by the scope, and only grows during the frame according the needed width.

// from real-world usage.
state
.max_desired_left_column_width
.at_most(0.7 * ui.max_rect().width()),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there should be a minimum width we don't go below (e.g. 32 points), and force the parent scope to have scroll bars instead

Suggested change
.at_most(0.7 * ui.max_rect().width()),
.at_most(0.7 * ui.max_rect().width()),
.at_least(MIN_LEFT_COLUMN_WIDTH)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree in principle, but suggest postponing any complexity-inducing improvement to when we actually reach into real world issues. I find very hard to predict how things will break exactly.

abey79 added a commit that referenced this pull request May 2, 2024
@abey79
Copy link
Member Author

abey79 commented May 2, 2024

All review comment addressed in #6183 (except the suggested postpone ☝🏻)

@abey79 abey79 force-pushed the antoine/li2-prop branch from 6705aef to 75d14f8 Compare May 2, 2024 13:40
Base automatically changed from antoine/li2-prop to main May 2, 2024 14:07
abey79 added a commit that referenced this pull request May 2, 2024
…property-like list items (#6174)

### What

This PR introduced the `PropertyContent`, an implementation of
`ListItemContent` for two-column list item, with a label and flexible
"values". Currently only demonstrated in `re_ui_example`.

What the "value" displays is delegated to a user-provided closure.
However, `PropertyContent` provides helper for a few basic types: bool,
text, color (both read-only and editable).

- Part of #6075
- Follow-up to #6161 


https://github.com/rerun-io/rerun/assets/49431240/bf94871a-63d5-46fa-94fe-a9adf720cdb8


### Limitations and todo

- Columns are fixed size at 50%. They will be made smart in [the next
PR.](#6182)
- More helpers are needed for various kinds of values.
- There can be only 0 or 1 action button. This should be extended by
using a `…` button with some kind of popup with all available actions in
a future PR.
- Right gutter space is reserved for the action button even if no list
item in scope use them. The `list_item_scope` could track this and skip
reserving that space if it's never used (e.g. component list in entity
path selection panel): #6179

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6174?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6174?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/6174)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
abey79 added 2 commits May 2, 2024 16:07
The current heuristics simply caps the label column to be 70%
@abey79 abey79 force-pushed the antoine/li3-smart-columns branch from cd2acf6 to 6228024 Compare May 2, 2024 14:08
@abey79 abey79 merged commit d086044 into main May 2, 2024
33 of 34 checks passed
@abey79 abey79 deleted the antoine/li3-smart-columns branch May 2, 2024 14:17
abey79 added a commit that referenced this pull request May 2, 2024
abey79 added a commit that referenced this pull request May 2, 2024
…ons when needed (#6183)

### What

☝🏻 

This PR also slightly adjust the semantics of the `id` parameter of
`list_item_scope()`. Now it just needs to be unique within the current
UI. It also addresses review comments from #6161, #6174, and #6182.

- Part of #6075
- Follow-up to #6182
- Fixes #6179


![Export-1714577757563](https://github.com/rerun-io/rerun/assets/49431240/45cb8284-15a9-4100-8057-bd7fd994d008)
<br/>

Note: the upper group of (nested) items (which makes use of action
buttons) has no impact on the lower group, because both sub-groups are
in a distinct `list_item_scope`.

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6183?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6183?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/6183)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
include in changelog ui concerns graphical user interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants