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

Provide descriptions against FCDOs and FCDAs in dataset view and picker (closes #6) #7

Closed

Conversation

danyill
Copy link

@danyill danyill commented Jan 22, 2024

Closes #6. See #6 for some screenshots of the current state to allow discussion of how to meet this goal.

We can also decide if this is an appropriate way to show descriptions.

I've decided:

  • Not to use type descriptions
  • Not to use the <DAI name="d">, VSD, nsdocs or others...

I finished the DA picker to illustrate the change but would need to do more:

  • Transfer approach to DO picker since the code is duplicated.
  • Decide how to show descriptions in constrained space for GOOSE/SV/Report editors (currently results in misalignment)
  • Decide how to truncate descriptions in picker (can we add labels somehow or a second line?)
  • Add unit tests
  • Add screenshot tests

As part of a drive by I also:

  • corrected the names which were identical for the DO and DA attribute pickers
  • added the FC to the DA attribute name in the picker

Happy to split these out as required.

@danyill danyill force-pushed the issue-6-provide-descriptions branch from 1f2de12 to 4f376e5 Compare January 22, 2024 09:15
@danyill danyill changed the title Provide descriptions against FCDOs and FCDAs in dataset view and picker (closes #6). Provide descriptions against FCDOs and FCDAs in dataset view and picker (closes #6) Jan 22, 2024
@danyill
Copy link
Author

danyill commented Feb 10, 2024

hi @JakobVogelsang WDYT about this? Can we discuss a little if this is an acceptable approach and practical within our current UI?

@danyill danyill force-pushed the issue-6-provide-descriptions branch from 4f376e5 to afff9f8 Compare July 28, 2024 02:39
@danyill
Copy link
Author

danyill commented Jul 28, 2024

This doesn't seem to be terribly far away:

In a space constrained environment the icons are not matching very well:

image

Which I can fix in the browser with:

image

image

@danyill
Copy link
Author

danyill commented Dec 23, 2024

With OpenEnergyTools/filterable-lists#6 some screenshots and an updated PR.
Here I have set the action-list height to 100px.

I've also made the full path be in the headline rather than the supporting text which TBH I think is easier to parse.

With smallish descriptions I don't think the whitespace is bothersome:

image

When the descriptions mean the list item is very full it becomes a little hard to read.
This was considerably worse when the first line also wrapped (often with the functional constraint):

image

image

Just barely acceptable in the dataset view?

image

I believe the list items are now always in line with the action items, but the list item height cannot vary with the supporting text so there is no more twoline

@danyill
Copy link
Author

danyill commented Dec 23, 2024

@JakobVogelsang as part of looking at OpenEnergyTools/filterable-lists#6 I would also be grateful if you could look at whether the changes here would be acceptable or heading in the right direction.

@danyill danyill force-pushed the issue-6-provide-descriptions branch from 4370e08 to 7a96e70 Compare December 24, 2024 10:29
@danyill
Copy link
Author

danyill commented Dec 24, 2024

This evening made some improvements with help from @ca-d to improve theming and distinguish the headline from the supporting text. Now looks more like:

image

Much better visual distinction when descriptions are large:

image

@danyill danyill marked this pull request as ready for review December 24, 2024 10:35
@danyill
Copy link
Author

danyill commented Dec 24, 2024

Not exactly finished, but ready for an initial review.

@danyill
Copy link
Author

danyill commented Dec 24, 2024

I will fix some broken tests and add new tests now, I feel this is close.

@danyill
Copy link
Author

danyill commented Dec 29, 2024

I have done what I can to fix tests and make them repeatable but I have not been entirely successful.

I have restricted tests to Chrome (there are way too many to visually check on multiple browsers given the current level of repeatability).
I have rolled some dependencies forward to see if this helped the visual tests or repeatability. I have rolled the Github image of Ubuntu back since the default has recently changed resulting in our wtr dependency requiring an update which has not yet happened.

This is a somewhat opinionated approach to descriptions - use the desc field preferentially, and DAI[d] otherwise and don't use DTTs but I think this is reasonable and consistent with what I've seen implememented. It's certainly a starting point.

Obviously it needs a release/update of @openenergytools/filterable-lists and for the corresponding PR there to be accepted before this PR is strictly valid.

@JakobVogelsang at an appropriate time I would be delighted to receive a review and happy to make improvements. I'm keen to get this over the line. I've done quite a few "drive-by" improvements/fixes (including fixing some earlier tests I broke). Nonetheless the whole visual tests remain quite unstable (but better than before).

This has ended up being a larger PR than I expected...

@JakobVogelsang
Copy link

Hi @danyill , this plugin is the next one to be scoped. As a first job I have fixed some security alerts and fixed tests. They are now running on chromium only and should be reliable. As a next step I will scope the plugin. Then I need to ask you to rebase again. I am sorry for giving so much extra work. My time is limited atm and this is the best spped I can do.

@danyill
Copy link
Author

danyill commented Jan 29, 2025

Then I need to ask you to rebase again.

No problem - I am grateful for your efforts and happy to rebase. I will then need to add the polyfill to our distribution and may need a little help.

@danyill
Copy link
Author

danyill commented Feb 7, 2025

This long-winded PR I will close in favour of #34 as it had many merge conflicts with the scoped component work.

@danyill danyill closed this Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide descriptions against FCDAs and FCDOs in dataset view and picker
2 participants