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

#2256 Add ability to display text description next to heading label #2263

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

#2256 Add ability to display text description next to heading label #2263

wants to merge 20 commits into from

Conversation

srikant-ch5
Copy link
Contributor

Fixes: #2256

Developer's Certificate of Origin 1.1

   By making a contribution to this project, I certify that:

   (a) The contribution was created in whole or in part by me and I
       have the right to submit it under the Apache License 2.0; or

   (b) The contribution is based upon previous work that, to the best
       of my knowledge, is covered under an appropriate open source
       license and I have the right under that license to submit that
       work with modifications, whether created in whole or in part
       by me, under the same open source license (unless I am
       permitted to submit under a different license), as indicated
       in the file; or

   (c) The contribution was provided directly to me by some other
       person who certified (a), (b) or (c) and I have not modified
       it.

   (d) I understand and agree that this project and the contribution
       are public and that a record of the contribution (including all
       personal information I submit with it, including my sign-off) is
       maintained indefinitely and may be redistributed consistent with
       this project or the open source license(s) involved.

@srikant-ch5 srikant-ch5 self-assigned this Dec 6, 2024
@srikant-ch5 srikant-ch5 marked this pull request as draft December 6, 2024 16:24
@srikant-ch5 srikant-ch5 requested a review from nmgokhale December 6, 2024 16:25
@srikant-ch5
Copy link
Contributor Author

Hi @nmgokhale I am trying to include below design for Properties Heading help button.

It will look like below
Screenshot 2024-12-06 at 9 56 39 PM

srikant-ch5
srikant-ch5 commented Dec 6, 2024
View reviewed changes
canvas_modules/harness/test_resources/parameterDefs/readonly_paramDef.json
"name": "number"
}
}
}
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nmgokhale Is it okay if the help object is updated like this in paramDef to fetch description and link ?

Copy link
Member

Choose a reason for hiding this comment

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

I think we should be using https://github.com/elyra-ai/pipeline-schemas/blob/main/common-pipeline/operators/uihints-v3-schema.json#L23. I don't think we need to add another description object.

We'd need a config option though that would allow users to determine if descriptions are included or not.

Copy link
Contributor Author

@srikant-ch5 srikant-ch5 Jan 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@matthoward366 I have updated PR to use description. Could you please have a look and let me know if the usage is fine ? (few changes pending, such as updating description.link.propertyId and description.default, and I will make those updates soon.). I have also included a config option headingDesc to switch between help button and tooltip.

srikant-ch5
srikant-ch5 commented Dec 6, 2024
View reviewed changes
canvas_modules/common-canvas/src/common-properties/components/title-editor/title-editor.jsx Outdated
tip={this.props.help?.data?.description?.label}
link={this.props.help?.data?.description?.link ? this.props.help?.data?.description?.link : null}
tooltipLinkHandler={this.props.controller.getHandlers().tooltipLinkHandler}
direction="bottom"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nmgokhale here should tooltipLinkHandler be adjusted to call helpClickHandler ?

@srikant-ch5 srikant-ch5 marked this pull request as ready for review January 8, 2025 14:19
@srikant-ch5
Fix test cases
30b7f47 
Signed-off-by: srikant <[email protected]>
@srikant-ch5
uncomment test cases
be033c1 
Signed-off-by: srikant <[email protected]>
@srikant-ch5
fix test case 2
762748b 
Signed-off-by: srikant <[email protected]>
@matthoward366
Copy link
Member

@nmgokhale can you take a first look?

nmgokhale
nmgokhale reviewed Jan 10, 2025
View reviewed changes
...dules/harness/src/client/components/sidepanel/properties/sidepanel-properties-param-def.json
{
"parameter_ref": "showHeadingDesc",
"label": {
"default": "headingDesc"
Copy link
Member

Choose a reason for hiding this comment

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

Change the label to showHeadingDesc. Label should match with the config option.

@nmgokhale
Copy link
Member

nmgokhale commented Jan 10, 2025 •
edited
Loading

When showHeadingDesc is checked, info icon is misaliged -
Screenshot 2025-01-10 at 10 58 45 AM

Button label should be Help -
Screenshot 2025-01-10 at 11 20 05 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nmgokhale nmgokhale nmgokhale left review comments

@matthoward366 matthoward366 Awaiting requested review from matthoward366

Requested changes must be addressed to merge this pull request.

Assignees

@srikant-ch5 srikant-ch5

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add ability to display text description next to heading label
3 participants
@srikant-ch5 @matthoward366 @nmgokhale