microsoft
[Dialog] Add event before closing panel to allow validation of the data provided by the user
…ta. (#1508)
Pull Request
📖 Description
I've added functionality to prevent the panel from closing if rules defined by the user don't pass.
I've added a func
🎫 Issues
#1508
👩💻 Reviewer Notes
📑 Test Plan
✅ Checklist
General
- [ ] I have added tests for my changes.
- [X] I have tested my changes.
- [X] I have updated the project documentation to reflect my changes.
- [X] I have read the CONTRIBUTING documentation and followed the standards for this project.
Component-specific
- [ ] I have added a new component
- [ ] I have added Unit Tests for my new component
- [X] I have modified an existing component
- [ ] I have validated the Unit Tests for an existing component
⏭ Next Steps
@microsoft-github-policy-service agree [company="{Nectar Sistemas}"]
[cid:c7339ad7-a11d-4ad0-a568-280eab5c3581]
From: microsoft-github-policy-service[bot] @.> Sent: Tuesday, September 3, 2024 15:41 To: microsoft/fluentui-blazor @.> Cc: Diego M. Ribeiro @.>; Mention @.> Subject: Re: [microsoft/fluentui-blazor] [Dialog] Add event before closing panel to allow validation of the data provided by the user (PR #2614)
@diegomodolohttps://github.com/diegomodolo please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
- (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement Contribution License Agreement
This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.
- Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.orghttp://www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
- Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
- Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
- Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
- Licenses.
- Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
- Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
- Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
- Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
- Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
- Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
- Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
- Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.
— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/fluentui-blazor/pull/2614#issuecomment-2327181474, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AC5UMPI6QKBDV2R2BYEGI6DZUX7ENAVCNFSM6AAAAABNSW3KIWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMRXGE4DCNBXGQ. You are receiving this because you were mentioned.Message ID: @.***>
@microsoft-github-policy-service agree company="Nectar Sistemas"
[cid:c0a63e77-4275-4add-9ea1-e279fdc54b86]
From: microsoft-github-policy-service[bot] @.> Sent: Tuesday, September 3, 2024 15:41 To: microsoft/fluentui-blazor @.> Cc: Diego M. Ribeiro @.>; Mention @.> Subject: Re: [microsoft/fluentui-blazor] [Dialog] Add event before closing panel to allow validation of the data provided by the user (PR #2614)
@diegomodolohttps://github.com/diegomodolo please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:
- (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
- (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement Contribution License Agreement
This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.
- Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.orghttp://www.opensource.org). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation.
- Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project.
- Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions.
- Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions.
- Licenses.
- Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties.
- Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project.
- Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise.
- Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
- Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect.
- Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission.
- Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens.
- Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.
— Reply to this email directly, view it on GitHubhttps://github.com/microsoft/fluentui-blazor/pull/2614#issuecomment-2327181474, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AC5UMPI6QKBDV2R2BYEGI6DZUX7ENAVCNFSM6AAAAABNSW3KIWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMRXGE4DCNBXGQ. You are receiving this because you were mentioned.Message ID: @.***>
Nice work! We need to take a closer look of course, but on first quick glance this look good and simple.
We are on the brink of releasing a new version. If we approve and merge, this will go into the next one then.
Interesting.
Why not use OnClosing? Possibly by adding a Cancelled parameter.
I also find the On suffix indicates that this is an EventCallback, which is not the case.
Interesting.
Why not use
OnClosing? Possibly by adding aCancelledparameter.I also find the
Onsuffix indicates that this is anEventCallback, which is not the case.
I thought about the parameter, but I would have to add it to DialogInstance, and I thought it would be more confusing since the property would not relate to the context of the class.
About the On prefix, I can change it, no problem.
You could add this parameter to a inherited class of DialogInstance (like DialogInstanceClosing).
My question is more: why to have similar "events". A
Func<bool> like you did can solve this problem, but using a Closing event can be more intuitive, no? 🙂
You could add this parameter to a inherited class of DialogInstance (like
DialogInstanceClosing).My question is more: why to have similar "events". A
Func<bool>like you did can solve this problem, but using aClosingevent can be more intuitive, no? 🙂
I totally agree with you, it would make much more sense. I will abandon this PR, make the changes and create a new one.
My reflection is more like used by the old (but excellent) WinForms 😁
https://learn.microsoft.com/en-us/dotnet/api/system.windows.forms.form.formclosing
I will abandon this PR, make the changes and create a new one.
No keep opened this PR until you find another solution. May be my idea is false and your PR will be better.
@diegomodolo
Wouldn't it make more sense to have an asynchronous version of this 'OnDialogValidation'?
Func<Task<bool>> OnDialogValidationAsync
Most of the time, some validation logic will require async calls to DB, API etc, so having sync callbacks only, seems not to be enough (at least for me).
Or am I just missing something and it's possible to call some async method right now?
My question is more: why to have similar "events". A
Func<bool>like you did can solve this problem, but using aClosingevent can be more intuitive, no? 🙂
@dvoituron And I feel the same way. The OnDialogValidation event/callback seems to be a really specific use case (but I agree that it could be used a lot), and the components in the core library should stay in a more generic way, and then maybe some more specific use cases should be implemented using the composition approach. Because now, if I'm right, the validation behaviour could be achieved using the OnDialogClosing event callback, and if the closing should be stopped then inside that callback we should throw an exception (which is far from perfect, I guess, but it works).
but it works
After testing, I see that it doesn't work
What is the status of this PR? Is it good to go as-is or do we want/still need to change anything?
Hi @vnbaaij , I would like to apologize for not being active at this thread. It is my first contribution at a plublic repository like this, so I did not know the right steps. I agree with the modification proposed by @lsurma to make the event async and I will make the changes. Regarding @dvoituron proposal, I agree that having everything on the same event would make more sense, I did not develop it that way because I did not want to "mess" with the original code.
Anyway, I would like to know the correct steps to amend my PR, if anyone could help me.
No need to apologize. Your contributions are always appreciated!
Just do the changes you want to make in your branch, push them to this PR and let us know know if and when you want us to review stuff.
Hi @vnbaaij, @dvoituron & @diegomodolo, I was wondering it there already is an update of when these changes will be released? 😊
No news from our side. Thin @diegomodolo stille wants to make some changes to this PR. So it is not ready yet.
We never give dates or put dates on releases. We release when we think a release is ready.
Hey @diegomodolo! Would be great if you can make the final changes to this PR. Thanks.