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

[4285] Fix direct edit when the palette is closed #4316

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mcharfadi
Copy link
Contributor

Bug: #4285

Pull request template

General purpose

What is the main goal of this pull request?

  • Bug fixes
  • New features
  • Documentation
  • Cleanup
  • Tests
  • Build / releng

Project management

  • Has the pull request been added to the relevant project and milestone? (Only if you know that your work is part of a specific iteration such as the current one)
  • Have the priority: and pr: labels been added to the pull request? (In case of doubt, start with the labels priority: low and pr: to review later)
  • Have the relevant issues been added to the pull request?
  • Have the relevant labels been added to the issues? (area:, difficulty:, type:)
  • Have the relevant issues been added to the same project and milestone as the pull request?
  • Has the CHANGELOG.adoc been updated to reference the relevant issues?
  • Have the relevant API breaks been described in the CHANGELOG.adoc? (Including changes in the GraphQL API)
  • In case of a change with a visual impact, are there any screenshots in the CHANGELOG.adoc? For example in doc/screenshots/2022.5.0-my-new-feature.png

Architectural decision records (ADR)

  • Does the title of the commit contributing the ADR start with [doc]?
  • Are the ADRs mentioned in the relevant section of the CHANGELOG.adoc?

Dependencies

  • Are the new / upgraded dependencies mentioned in the relevant section of the CHANGELOG.adoc?
  • Are the new dependencies justified in the CHANGELOG.adoc?

Frontend

This section is not relevant if your contribution does not come with changes to the frontend.

General purpose

  • Is the code properly tested? (Plain old JavaScript tests for business code and tests based on React Testing Library for the components)

Typing

We need to improve the typing of our code, as such, we require every contribution to come with proper TypeScript typing for both changes contributing new files and those modifying existing files.
Please ensure that the following statements are true for each file created or modified (this may require you to improve code outside of your contribution).

  • Variables have a proper type
  • Functions’ arguments have a proper type
  • Functions’ return type are specified
  • Hooks are properly typed:
    • useMutation<DATA_TYPE, VARIABLE_TYPE>(…)
    • useQuery<DATA_TYPE, VARIABLE_TYPE>(…)
    • useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)
    • useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)
    • useState<STATE_TYPE>(…)
  • All components have a proper typing for their props
  • No useless optional chaining with ?. (if the GraphQL API specifies that a field cannot be null, do not treat it has potentially null for example)
  • Nullable values have a proper type (for example let diagram: Diagram | null = null;)

Backend

This section is not relevant if your contribution does not come with changes to the backend.

General purpose

  • Are all the event handlers tested?
  • Are the event processor tested?
  • Is the business code (services) tested?
  • Are diagram layout changes tested?

Architecture

  • Are data structure classes properly separated from behavioral classes?
  • Are all the relevant fields final?
  • Is any data structure mutable? If so, please write a comment indicating why
  • Are behavioral classes either stateless or side effect free?

Review

How to test this PR?

Please describe here the various use cases to test this pull request

  • Has the Kiwi TCMS test suite been updated with tests for this contribution?

@mcharfadi mcharfadi added this to the 2025.1.0 milestone Dec 16, 2024
@mcharfadi mcharfadi requested a review from gcoutable as a code owner December 16, 2024 13:15
@mcharfadi mcharfadi linked an issue Dec 16, 2024 that may be closed by this pull request
@mcharfadi mcharfadi force-pushed the mch/fix/directEdit branch 2 times, most recently from 8ad2c42 to 784af1c Compare December 16, 2024 14:18
Copy link
Member

@sbegaudeau sbegaudeau left a comment

Choose a reason for hiding this comment

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

Something somewhere in this PR is breaking the behavior of the palette in multiple use cases, I can't reopen a closed palette, some behavior like the delete is only working half the time.

if ((event.altKey && key === 'Alt') || (event.shiftKey && key === 'Shift') || isTextField || readOnly) {
return;
}
/*If the palette is opened, do nothing*/
Copy link
Member

Choose a reason for hiding this comment

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

1- Why?
2- This does not work, it only works half the time so why?

Why can't I click an edge and use the key Delete to delete it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If you open the palette you have the focus on the searchfield input and as such we want to keep the use of the Delete key to manipulate the text in the field.
You have to close the palette to Delete the element or click a tool.

return;
}

/*When the palette is opened, allow direct edit only with F2 so we can type in the palette search field*/
Copy link
Member

Choose a reason for hiding this comment

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

Why break the existing behavior that has worked for years on both desktop and web?

Copy link
Member

Choose a reason for hiding this comment

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

Even that does not work properly, I can successfully bypass it sometimes to restore the original behavior.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure it's comparable with the desktop version. Here when we open the palette we want to have the focus on the searchfield input and as such we can use direct edit only with F2 if the palette is opened.
If the palette is closed then F2 or typing can be used to start the direct edit.

Do you mean the direct-edit is starting when typing on the searchfield with the PR?

@sbegaudeau sbegaudeau removed this from the 2025.1.0 milestone Dec 22, 2024
@mcharfadi mcharfadi force-pushed the mch/fix/directEdit branch 2 times, most recently from 652bd5d to c24f5a5 Compare December 31, 2024 10:19
@mcharfadi mcharfadi added this to the 2025.2.0 milestone Dec 31, 2024
@mcharfadi
Copy link
Contributor Author

mcharfadi commented Dec 31, 2024

I made several changes to the PR :

  • We can use direct edit or del key if the palette is opened but the input field is not focused (F2 work event if the input field is focused)
  • The palette or one of the child element should always have the focus in order to be able to use the key event handler
  • When clicking the arrow in the search field, we don't loose the focus anymore
  • To use the del key you must not have the focus on the input field but you can click anywhere on the palette or press tab in order to delete the element

Also note that we have an issue with the tabindex of the quicktools that use the Tool.tsx component and as such pressing tab does not produce the expected result when selecting quicktools.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

After closing the palette with ESC, direct edit does not work
2 participants