OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook #14707

kyoto · 2025-01-31T12:18:08Z

No description provided.

openshift-ci-robot · 2025-01-31T12:18:12Z

@kyoto: This pull request references OLS-1330 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.19.0" version, but no target version was set.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2025-01-31T12:36:41Z

@kyoto: This pull request references Jira Issue OCPBUGS-49709, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

bug is open, matching expected state (open)
bug target version (4.19.0) matches configured target version for branch (4.19.0)
bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

jgbernalp · 2025-01-31T12:58:01Z

frontend/packages/console-dynamic-plugin-sdk/src/app/modal-support/ModalProvider.tsx


  return (
    <ModalContext.Provider value={{ launchModal, closeModal }}>
      {isOpen && !!Component && <Component {...componentProps} closeModal={closeModal} />}
+      {_.map(componentsMap, (c, id) => (
+        <c.Component {...c.props} key={id} closeModal={closeModal} />


I think close modal needs the id:

Suggested change

<c.Component {...c.props} key={id} closeModal={closeModal} />

<c.Component {...c.props} key={id} closeModal={(e) => closeModal(e,id)} />

Thanks @jgbernalp! I refactored a bit based on your suggestion.

spadgett · 2025-02-03T14:51:53Z

/assign @vojtechszocs
/assign @TheRealJon

jgbernalp · 2025-03-11T07:44:43Z

/test e2e-gcp-console

kyoto · 2025-03-11T07:46:46Z

/cherrypick release-4.18

openshift-cherrypick-robot · 2025-03-11T07:46:49Z

@kyoto: once the present PR merges, I will cherry-pick it on top of release-4.18 in a new PR and assign it to you.

In response to this:

/cherrypick release-4.18

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

kyoto · 2025-03-11T07:47:04Z

/cherrypick release-4.17

openshift-cherrypick-robot · 2025-03-11T07:47:06Z

@kyoto: once the present PR merges, I will cherry-pick it on top of release-4.17 in a new PR and assign it to you.

In response to this:

/cherrypick release-4.17

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

kyoto · 2025-03-11T13:31:06Z

/test e2e-gcp-console

kyoto · 2025-03-11T13:32:00Z

@vojtechszocs @TheRealJon Could one of you please review?

kyoto · 2025-03-12T10:58:26Z

/retest

spadgett

Thanks @kyoto 👍

spadgett · 2025-03-14T14:45:53Z

frontend/packages/console-dynamic-plugin-sdk/docs/api.md


 ### Summary 

-A hook to launch Modals.
+A hook to launch Overlays.


I know the useModal description and others are terse, but I'd like to try to add more detail to these going forward and eventually fix existing API docs. Let's add more description here. Some questions that come to mind:

What is an overlay?

How do I position an overlay?

How do I close an overlay?

Can I launch multiple overlays?

Can I make an overlay modal?

What props if any can the component I pass in take?

What PF or SDK components can I use with overlays?

Thanks @spadgett! I expanded the API docs with your suggestions. Could you please take another look?

spadgett · 2025-03-14T14:46:41Z

frontend/packages/console-dynamic-plugin-sdk/docs/api.md

+
+## `useModal`
+
+### Summary [DEPRECATED]


@opayne1 FYI, we're deprecating a hook from the console plugin API. We should look at release noting this. Let us know what we need to do.

frontend/packages/console-dynamic-plugin-sdk/docs/api.md

spadgett

@kyoto Thank you, I really appreciate the doc updates. API looks good 👍

I'll let @vojtechszocs give the final lgtm.

/approved
/label plugin-api-approved

openshift-ci · 2025-04-08T14:00:19Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kyoto, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~dynamic-demo-plugin/OWNERS~~ [kyoto,spadgett]
~~frontend/OWNERS~~ [kyoto,spadgett]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

kyoto · 2025-04-09T01:22:52Z

/retest

kyoto · 2025-04-09T05:38:09Z

/retest

openshift-ci · 2025-04-09T08:07:37Z

@kyoto: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/okd-scos-e2e-aws-ovn	`143f213`	link	false	`/test okd-scos-e2e-aws-ovn`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jan 31, 2025

openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 31, 2025

openshift-ci bot requested review from rawagner and spadgett January 31, 2025 12:18

openshift-ci bot added component/sdk Related to console-plugin-sdk approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 31, 2025

kyoto changed the title ~~[WIP] OLS-1330: Add the ability to launch multiple modals with useModal hook~~ [WIP] OCPBUGS-49709: Add the ability to launch multiple modals with useModal hook Jan 31, 2025

openshift-ci-robot added the jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. label Jan 31, 2025

openshift-ci bot requested a review from yapei January 31, 2025 12:36

jgbernalp reviewed Jan 31, 2025

View reviewed changes

kyoto force-pushed the ModalProvider-multiple-modals branch 2 times, most recently from 5242806 to 83d020f Compare January 31, 2025 13:53

openshift-ci bot assigned TheRealJon and vojtechszocs Feb 3, 2025

kyoto force-pushed the ModalProvider-multiple-modals branch from 83d020f to 17195c3 Compare March 11, 2025 02:31

openshift-ci bot added component/core Related to console core functionality plugin-api-changed Categorizes a PR as containing plugin API changes labels Mar 11, 2025

openshift-ci bot assigned jhadvig and spadgett Mar 11, 2025

kyoto changed the title ~~[WIP] OCPBUGS-49709: Add the ability to launch multiple modals with useModal hook~~ [WIP] OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook Mar 11, 2025

kyoto changed the title ~~[WIP] OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook~~ OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook Mar 13, 2025

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 13, 2025

spadgett reviewed Mar 14, 2025

View reviewed changes

kyoto force-pushed the ModalProvider-multiple-modals branch from 17195c3 to 12d18c6 Compare April 8, 2025 13:43

spadgett approved these changes Apr 8, 2025

View reviewed changes

openshift-ci bot added the plugin-api-approved Indicates a PR with plugin API changes has been approved by an API reviewer label Apr 8, 2025

Add the ability to launch multiple modals with useModal hook

143f213

kyoto force-pushed the ModalProvider-multiple-modals branch from 12d18c6 to 143f213 Compare April 8, 2025 14:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook #14707

OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook #14707

kyoto commented Jan 31, 2025

openshift-ci-robot commented Jan 31, 2025 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Jan 31, 2025

jgbernalp Jan 31, 2025

kyoto Jan 31, 2025

spadgett commented Feb 3, 2025

jgbernalp commented Mar 11, 2025

kyoto commented Mar 11, 2025

openshift-cherrypick-robot commented Mar 11, 2025

kyoto commented Mar 11, 2025

openshift-cherrypick-robot commented Mar 11, 2025

kyoto commented Mar 11, 2025

kyoto commented Mar 11, 2025

kyoto commented Mar 12, 2025

spadgett left a comment

spadgett Mar 14, 2025 •

edited

Loading

kyoto Apr 8, 2025

spadgett Mar 14, 2025

spadgett left a comment

openshift-ci bot commented Apr 8, 2025

kyoto commented Apr 9, 2025

kyoto commented Apr 9, 2025

openshift-ci bot commented Apr 9, 2025

	<c.Component {...c.props} key={id} closeModal={closeModal} />
	<c.Component {...c.props} key={id} closeModal={(e) => closeModal(e,id)} />

OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook #14707

Are you sure you want to change the base?

OCPBUGS-49709: Add useOverlay hook to dynamic plugin SDK and deprecate useModal hook #14707

Conversation

kyoto commented Jan 31, 2025

openshift-ci-robot commented Jan 31, 2025 • edited by openshift-ci bot Loading

openshift-ci-robot commented Jan 31, 2025

jgbernalp Jan 31, 2025

Choose a reason for hiding this comment

kyoto Jan 31, 2025

Choose a reason for hiding this comment

spadgett commented Feb 3, 2025

jgbernalp commented Mar 11, 2025

kyoto commented Mar 11, 2025

openshift-cherrypick-robot commented Mar 11, 2025

kyoto commented Mar 11, 2025

openshift-cherrypick-robot commented Mar 11, 2025

kyoto commented Mar 11, 2025

kyoto commented Mar 11, 2025

kyoto commented Mar 12, 2025

spadgett left a comment

Choose a reason for hiding this comment

spadgett Mar 14, 2025 • edited Loading

Choose a reason for hiding this comment

kyoto Apr 8, 2025

Choose a reason for hiding this comment

spadgett Mar 14, 2025

Choose a reason for hiding this comment

spadgett left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Apr 8, 2025

kyoto commented Apr 9, 2025

kyoto commented Apr 9, 2025

openshift-ci bot commented Apr 9, 2025

openshift-ci-robot commented Jan 31, 2025 •

edited by openshift-ci bot

Loading

spadgett Mar 14, 2025 •

edited

Loading