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

Removed sorting from ListGroup component #353

Merged
merged 13 commits into from
May 28, 2024

Conversation

AlexanderSkrock
Copy link
Contributor

@AlexanderSkrock AlexanderSkrock commented Apr 26, 2024

This pull request aims to fix #311 . Currently, it is being developed.

  • Remove "shouldSort" property
  • Warn if this property is still used
  • Adjust testcases
  • Write a note in CHANGELOG.md
  • Discover dependant components in potentially reliant other projects. This includes to remove the flag and if sorting is necessary to reimplement the sorting on this level.

Closes #311

@nikku
Copy link
Member

nikku commented Apr 26, 2024

@AlexanderSkrock Great to see you picking this up. You should be able to link both projects, this core + bpmn-js-properties-panel to test them together:

cd bpmn-js-properties-panel
npm link ../properties-panel

...

@AlexanderSkrock AlexanderSkrock marked this pull request as ready for review April 29, 2024 07:29
@AlexanderSkrock
Copy link
Contributor Author

AlexanderSkrock commented Apr 29, 2024

This pull request together with changes made in #1047 in bpmn-properties-panel should be good to go now, from my point of view.

One more question, I saw that we released properties-panel version 3.18.2 already, so we would need to increment and also update it for bpmn-js-properties-panel. Is this a step which is done automatically during the release process?

@nikku
Copy link
Member

nikku commented Apr 29, 2024

@AlexanderSkrock You'd want to rebase this PR on main before merge.

@nikku
Copy link
Member

nikku commented Apr 29, 2024

Once you did it then I can give it my review.

@AlexanderSkrock
Copy link
Contributor Author

@AlexanderSkrock You'd want to rebase this PR on main before merge.

I checked once again, but it seems my commits were based on main's head already.

@nikku
Copy link
Member

nikku commented May 2, 2024

Will look into your changes today. Thanks already for your work 👏

CHANGELOG.md Outdated Show resolved Hide resolved
@nikku
Copy link
Member

nikku commented May 6, 2024

After some distractions I hope I find the time to finalize my review + testing tomorrow.

@nikku
Copy link
Member

nikku commented May 6, 2024

I found the time to review the change, along with bpmn-io/bpmn-js-properties-panel#1047.

A few notes:

  • From what it looks to me the change is incomplete. Looking at sorting at the core List#compareFn is used along with sorting to implement sort features; without sorting there is no necessity for compareFn, we want to ditch it which I sketched in bpmn-io/bpmn-js-properties-panel@d883a0f.

  • Integration testing Do not sort list items alphabetically bpmn-js-properties-panel#1047 I found a bunch of places where auto focus is now broken; we want to ensure that items are added last to the list (no magic), and focused regardless, sketched for Execution Listeners > Execution Listener > Field injections via bpmn-io/bpmn-js-properties-panel@9953514). Without that change in the relevant places we see the following interaction, shown on the example of User Task (Generated Form): Form Fields > Field > Properties:

    capture nSTWvz_optimized

Other than that the solution feels solid, improves C7, and does not break C8 functionality (where we do not sort already ™️). Good job!

Copy link
Member

@nikku nikku left a comment

Choose a reason for hiding this comment

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

Consider to ditch List#compareFn, cf. #353 (comment).

@nikku
Copy link
Member

nikku commented May 28, 2024

Waiting for CI to pass before we go ahead and merge this.

@nikku nikku changed the title #311 removed sorting from ListGroup component Removed sorting from ListGroup component May 28, 2024
CHANGELOG.md Outdated Show resolved Hide resolved
@nikku nikku merged commit bb1cfb0 into bpmn-io:main May 28, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Do not sort entries alphabetically
2 participants