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.

Sign up for GitHub

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

Jump to bottom

[3981] Display the diagram palette tools and tool sections in a list #4016

Merged
merged 2 commits into from
Nov 27, 2024
Merged

[3981] Display the diagram palette tools and tool sections in a list #4016

merged 2 commits into from
Nov 27, 2024

Conversation

florianbarbin
Copy link
Contributor

@florianbarbin florianbarbin commented Sep 18, 2024 •
edited
Loading

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?

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

@florianbarbin florianbarbin added this to the 2024.11.0 milestone Sep 18, 2024
@florianbarbin florianbarbin marked this pull request as draft September 18, 2024 12:21
@florianbarbin florianbarbin force-pushed the fba/enh/displayPaletteToolsAsList branch 2 times, most recently from f9529be to 040b113 Compare September 19, 2024 07:58
@florianbarbin florianbarbin marked this pull request as ready for review September 19, 2024 08:06
@florianbarbin florianbarbin force-pushed the fba/enh/displayPaletteToolsAsList branch 12 times, most recently from 99c2415 to 4588262 Compare September 26, 2024 08:33
@florianbarbin florianbarbin linked an issue Sep 27, 2024 that may be closed by this pull request
Update the design and capabilities of the contextual palette #3981
Closed
@florianbarbin florianbarbin force-pushed the fba/enh/displayPaletteToolsAsList branch 7 times, most recently from fd2f293 to 91107b5 Compare October 2, 2024 14:56
@florianbarbin florianbarbin force-pushed the fba/enh/displayPaletteToolsAsList branch 2 times, most recently from 94f08d8 to 3b4833f Compare October 9, 2024 20:51
@florianbarbin florianbarbin force-pushed the fba/enh/displayPaletteToolsAsList branch from 3b4833f to 4b42883 Compare October 15, 2024 18:43
@sbegaudeau sbegaudeau mentioned this pull request Oct 23, 2024
Closed
39 tasks
sbegaudeau
sbegaudeau previously requested changes Oct 23, 2024
View reviewed changes
packages/diagrams/frontend/sirius-components-diagrams/package.json Outdated Show resolved Hide resolved
packages/diagrams/frontend/sirius-components-diagrams/package.json Outdated Show resolved Hide resolved
CHANGELOG.adoc Outdated Show resolved Hide resolved
.../eclipse/sirius/components/compatibility/services/diagrams/CompatibilityPaletteProvider.java Outdated Show resolved Hide resolved
...ms/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/IPaletteEntry.java Show resolved Hide resolved
...nd/sirius-components-diagrams/src/renderer/palette/tool-list/PaletteToolSectionList.types.ts Outdated Show resolved Hide resolved
...nd/sirius-components-diagrams/src/renderer/palette/tool/DiagramPaletteToolExtensionPoints.ts Show resolved Hide resolved
packages/diagrams/frontend/sirius-components-diagrams/src/renderer/palette/usePalette.tsx
break;
}
};
return { handleToolClick, palette };
Copy link
Member

Choose a reason for hiding this comment

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

It's nice to extract this code from the palette but all these various concerns shouldn't be grouped together.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It could be better but the idea is to make it easier to distinguish the business part from the ui part

Copy link
Contributor

Choose a reason for hiding this comment

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

We might want to have a dedicated usePalette hook that would return the palette and another useTool that would return the handleToolclick function.
This is would require handling the direct edit differently, I'll make the change later.

packages/diagrams/frontend/sirius-components-diagrams/src/renderer/palette/usePalette.types.ts Outdated
* Obeo - initial API and implementation
*******************************************************************************/

import { GQLMessage } from '../Tool.types';
Copy link
Member

Choose a reason for hiding this comment

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

Same comment here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We could separate the part necessary to provide the palette it self from the mutations

Copy link
Contributor

Choose a reason for hiding this comment

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

We might want to have a dedicated usePalette hook that would return the palette and another useTool that would return the handleToolclick function.
This is would require handling the direct edit differently, I'll make the change later.

...rc/main/java/org/eclipse/sirius/components/view/emf/diagram/PaletteDefaultToolsProvider.java Outdated Show resolved Hide resolved
@sbegaudeau sbegaudeau force-pushed the fba/enh/displayPaletteToolsAsList branch from 4b42883 to c24950d Compare October 23, 2024 15:14
@florianbarbin florianbarbin force-pushed the fba/enh/displayPaletteToolsAsList branch from 4553fae to 15b365c Compare October 25, 2024 17:44
@sbegaudeau sbegaudeau modified the milestones: 2024.11.0, 2025.1.0 Oct 29, 2024
@florianbarbin @mcharfadi
[3990] Make the diagram contextual palette draggable
8c17f04 
Bug: #3990
Signed-off-by: Florian Barbin <florian.barbin@obeo.fr>
@mcharfadi mcharfadi force-pushed the fba/enh/displayPaletteToolsAsList branch 4 times, most recently from 0673622 to 293413a Compare November 26, 2024 13:49
@mcharfadi
Copy link
Contributor

We had too much files on the same directory so I moved some of them in dedicated ones.
I tested and simplified some code.

I did not :
Move Tool.tsx in quick-access-tool directory since it's only used there.
Separate usePalette in 2 hooks

@mcharfadi mcharfadi force-pushed the fba/enh/displayPaletteToolsAsList branch 2 times, most recently from 71155dc to 7be68fe Compare November 26, 2024 16:19
@florianbarbin @mcharfadi
[3981] Display the diagram palette tools and tool sections in a list
7f7f71c 
Bug: #3981
Signed-off-by: Florian Barbin <florian.barbin@obeo.fr>
Signed-off-by: Michaël Charfadi <michael.charfadi@obeosoft.com>
@mcharfadi mcharfadi force-pushed the fba/enh/displayPaletteToolsAsList branch from 7be68fe to 7f7f71c Compare November 27, 2024 08:01
@sbegaudeau sbegaudeau dismissed their stale review November 27, 2024 08:43

@mcharfadi has reviewed the PR

@mcharfadi mcharfadi merged commit 9b41058 into master Nov 27, 2024
4 checks passed
@mcharfadi mcharfadi deleted the fba/enh/displayPaletteToolsAsList branch November 27, 2024 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mcharfadi mcharfadi mcharfadi approved these changes

@pcdavid pcdavid Awaiting requested review from pcdavid pcdavid is a code owner

@gcoutable gcoutable Awaiting requested review from gcoutable gcoutable is a code owner

@AxelRICHARD AxelRICHARD Awaiting requested review from AxelRICHARD AxelRICHARD is a code owner

@sbegaudeau sbegaudeau Awaiting requested review from sbegaudeau sbegaudeau is a code owner

Assignees
No one assigned
Labels
pr: to review later priority: high
Projects
None yet
Milestone
2025.1.0
Development

Successfully merging this pull request may close these issues.

Update the design and capabilities of the contextual palette
3 participants
@florianbarbin @mcharfadi @sbegaudeau