[doc] Add an ADR on support actions in table row context menu #4394
Conversation
| ```graphQL | ||
| type Table implements Representation { | ||
| ... | ||
| contextMenu(rowId: ID!): [RowContextMenuEntry!]! |
There was a problem hiding this comment.
The context menu would have a similar behavior as a diagram palette, it should be retrieved using TableDescription#contextMenu. We are always placing those kind of information on the representation description.
See the GraphQL schema of DiagramDescription#palette for example.
| input InvokeRowContextMenuEntryInput { | ||
| id: ID! | ||
| editingContextId: ID! | ||
| representationId: ID! |
There was a problem hiding this comment.
You will also need the tableId here given how tables are working
|
|
||
| As far as the context menu entries retrieval is concerned, the handler has an injected list of implementations of `IRowContextMenuEntryProvider`. | ||
| A developer could create directly an implementation of `IRowContextMenuEntryProvider` to use in a row of his/her table. | ||
| To manage the view DSL menu entries descriptions, we need to provide an implementation to expose the entries described at the View model level to the DTO element. This will be typically done inside the view converter of the Table description. |
There was a problem hiding this comment.
Technically it will happen at a different time than the view conversion since the view gets converted when the project is opened while the retrieval of the context menu entries will be done on the fly when the button gets clicked but the code will leave near the code of the table view converter.
|
|
||
| === Front end | ||
|
|
||
| The front end code relies on the GraphQL query `contextMenu` to populate the menu of each table row. We can afford to request all context menu entries for all rows when the component renders, instead, we need to request only the content of the context menu when it is open. |
There was a problem hiding this comment.
- Please use one sentence per line
- "We can afford" -> "We cannot afford"
Signed-off-by: Jerome Gout <[email protected]>
sbegaudeau
force-pushed
the
jgo/doc/add_adr_for_adding_support_of_actions_in_table_rows
branch
from
97de930 to
3836a32
Compare
Pull request template
General purpose
What is the main goal of this pull request?
Project management
priority:andpr:labels been added to the pull request? (In case of doubt, start with the labelspriority: lowandpr: to review later)area:,difficulty:,type:)CHANGELOG.adocbeen updated to reference the relevant issues?CHANGELOG.adoc? (Including changes in the GraphQL API)CHANGELOG.adoc? For example indoc/screenshots/2022.5.0-my-new-feature.pngArchitectural decision records (ADR)
[doc]?CHANGELOG.adoc?Dependencies
CHANGELOG.adoc?CHANGELOG.adoc?Frontend
This section is not relevant if your contribution does not come with changes to the frontend.
General purpose
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).
useMutation<DATA_TYPE, VARIABLE_TYPE>(…)useQuery<DATA_TYPE, VARIABLE_TYPE>(…)useSubscription<DATA_TYPE, VARIABLE_TYPE>(…)useMachine<CONTEXT_TYPE, EVENTS_TYPE>(…)useState<STATE_TYPE>(…)?.(if the GraphQL API specifies that a field cannot benull, do not treat it has potentiallynullfor 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
Architecture
Review
How to test this PR?
Please describe here the various use cases to test this pull request