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

Add support for optional help text on widgets #1988

Closed
11 tasks done
pcdavid opened this issue May 23, 2023 · 2 comments · Fixed by #1987 or #2011
Closed
11 tasks done

Add support for optional help text on widgets #1988

pcdavid opened this issue May 23, 2023 · 2 comments · Fixed by #1987 or #2011
Assignees
@pcdavid
Labels
difficulty: medium package: forms package: view size: smallbatch type: feature request
Milestone
2023.8.0

Comments

@pcdavid
Copy link
Member

pcdavid commented May 23, 2023 •
edited

In Sirius Desktop's EEF-based property views, it is possible to associate a help text on widgets that can display additional text in a tooltip.
We should also support this kind of mechanism in our Forms (including in View-based forms).

Tasks

  • Shape written
  • ADR written
  • Core support for AbstractWidget[Description].helpTextProvider and hasHelpText flag.
  • Implement the GraphQL Query to invoke a widget's helpTextProvider.
  • Frontend: display the "?" hint for widgets with hasHelpText (need more discussion on the icon and layout)
  • Frontend: invoke the GraphQL Query and display the result (as a tooltip)
  • View: add WidgetDescription.helpTextExpression
  • View: create a proper helpTextProvider from the expression during the View conversion.
  • Frontend: display the "?" hint in the FormDescriptionEditor version of the widgets (if the helpTextExpression is defined)
  • Add tests
  • Update documentation and CHANGELOG with a screenshot/animation.
@pcdavid pcdavid added this to the 2023.8.0 milestone May 23, 2023
@pcdavid pcdavid linked a pull request May 23, 2023 that will close this issue
[doc] Add shape for help expressions on widgets #1987
Merged
@pcdavid pcdavid mentioned this issue May 23, 2023
Merged
@pcdavid
Copy link
Member Author

pcdavid commented May 24, 2023

#1651 mentions the use of MUI's input adornments instead of an icon at the same level as the widget's title. I'll have a look but it's not clear that it would be applicable to all kinds of widgets in a uniform way (e.g. radio buttons, or more gererally custom widgets).

pcdavid added a commit that referenced this issue May 31, 2023
@pcdavid
[1988] Core support for the helpTextProvider
10a0143 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue May 31, 2023
@pcdavid
[1988] Declare the hasHelpText GraphQL field and fetch it in the front
c04ab5e 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue May 31, 2023
@pcdavid
[1988] add data fetcher and event handler to get the actual help text…
c0fe613 
… of a widget

Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue May 31, 2023
@pcdavid
[1988] Frontend
ac10ce3 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue May 31, 2023
@pcdavid
[1988] Add support in View-based Forms
d49126b 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
@pcdavid pcdavid linked a pull request May 31, 2023 that will close this issue
[1988] Add support for optional help text on widgets #2011
Merged
39 tasks
pcdavid added a commit that referenced this issue Jun 1, 2023
@pcdavid
[1988] Core support for the helpTextProvider
a923483 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 1, 2023
@pcdavid
[1988] Declare the hasHelpText GraphQL field and fetch it in the front
367be2d 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 1, 2023
@pcdavid
[1988] add data fetcher and event handler to get the actual help text…
f14ceb9 
… of a widget

Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 1, 2023
@pcdavid
[1988] Frontend
2ca6b9c 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 1, 2023
@pcdavid
[1988] Add support in View-based Forms
e69be60 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 1, 2023
@pcdavid
[1988] Add support for optional help text on widgets
351349f 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 5, 2023
@pcdavid
[1988] Add support for optional help text on widgets
12128fb 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 5, 2023
@pcdavid
[1988] Add support for optional help text on widgets
4223cda 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 6, 2023
@pcdavid
[1988] Add support for optional help text on widgets
e23ecaa 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 6, 2023
@pcdavid
[1988] Add support for optional help text on widgets
bcaf1be 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 6, 2023
@pcdavid
[1988] Add support for optional help text on widgets
e5b1349 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 6, 2023
@pcdavid
[1988] Add support for optional help text on widgets
76ccd1f 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 6, 2023
@pcdavid
[1988] Add support for optional help text on widgets
614d3d1 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 6, 2023
@pcdavid
[1988] Add support for optional help text on widgets
b0e8f73 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 6, 2023
@pcdavid
[1988] Add support for optional help text on widgets
281a777 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 7, 2023
@pcdavid
[1988] Add support for optional help text on widgets
cb34647 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 9, 2023
@pcdavid
[1988] Add support for optional help text on widgets
42bf953 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 12, 2023
@pcdavid
[1988] Add support for optional help text on widgets
e21eda7 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 15, 2023
@pcdavid
[1988] Add support for optional help text on widgets
d33c1db 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 15, 2023
@pcdavid
[1988] Add support for optional help text on widgets
78b2bb5 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
pcdavid added a commit that referenced this issue Jun 15, 2023
@pcdavid
[1988] Add support for optional help text on widgets
b26d9a3 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
@pcdavid
Copy link
Member Author

pcdavid commented Jun 15, 2023

The shape was merged, but not the actual implementation.

@pcdavid pcdavid reopened this Jun 15, 2023
sbegaudeau pushed a commit that referenced this issue Jun 19, 2023
@pcdavid @sbegaudeau
[1988] Add support for optional help text on widgets
8ae7820 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
sbegaudeau pushed a commit that referenced this issue Jun 19, 2023
@pcdavid @sbegaudeau
[1988] Add support for optional help text on widgets
cc74f97 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
sbegaudeau pushed a commit that referenced this issue Jun 19, 2023
@pcdavid @sbegaudeau
[1988] Add support for optional help text on widgets
ce4c5ee 
Bug: #1988
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pcdavid pcdavid

Labels
difficulty: medium package: forms package: view size: smallbatch type: feature request
Projects
None yet
Milestone
2023.8.0
1 participant
@pcdavid