Add disabled property for form text in ui-library

pkp / pkp-lib

The library used by PKP's applications OJS, OMP and OPS, open source software for scholarly publishing.

https://pkp.sfu.ca

GNU General Public License v3.0

307 stars 448 forks source link

Add disabled property for form text in ui-library #8850

Open withanage opened 1 year ago

withanage commented 1 year ago

Use case description

In OJS/OPS ORCiDs of contributors/co-authors can be authenticated, if the orcidProfile plugin is enabled and peroperly configured.
ORCiD of a contributor should not be manually editable , which is a formal requirement from ORCiD Organization for OJS to be an official service provider.
In current version of the UI-Library, the only available option for disabling the form text field is by using the optInEdit option.
optInEdit option adds an additional button, which in turn enables editing the disabled form text field, which is not acceptable by ORCiD requirements.
As orcidProfile Plugin is shipped as a OJS/OPS sub-module and is one of the mostly used author identifier standards, considering the support as a core-feature has to be considered.

Solution description

Add disabling function for fotm text fields
Add a default disabled prop for FieldBase

What application are you using? OJS 3.5 +

Additional information

Demo

NateWr commented 1 year ago

@withanage I've assigned this to the metadata and distribution team, because I think the motivation for this feature is the ORCID plugin. Is that right?

withanage commented 1 year ago

@NateWr thanks!

sure , it is ok for the Metadata and Distribution. The function is but generally a development what we need for the mail functions in CRAFT-OA project context.

NateWr commented 1 year ago

Thanks @withanage. I haven't heard about the mail functions. Can you describe the use case in more detail?

withanage commented 1 year ago

Thanks @withanage. I haven't heard about the mail functions. Can you describe the use case in more detail?

Sure , I have added some context and the use-case

Context

This is part of the GDPR support TIB plans to co-develop with TSV (Anttil-Jussi) . For the GDPR support , the infrastructure support will be done by PKP team and the functionality and use-cases are developed by TIB. The requirement comes from pkp-lib#3022 I have not assigned it yet, cause we were thinking of a creating a meta-issue for GDPR and linking the small issues together.

Use case

1.a > New modal window opens showing the users email (not editable) -Here we have to disable the email adress for the user in a form in a manner, which can be optionally enabled and should be possible for further refinements according to UX needs.

NateWr commented 1 year ago

@withanage I think you need to discuss further what this is actually going to look like. There is similar work done in https://github.com/pkp/pkp-lib/issues/7391 and @Devika008 has contributed a suggested design pattern for enabled/disabled sections of forms here: https://github.com/pkp/pkp-lib/issues/7391#issuecomment-1254882253.

Can you follow up with a more detailed proposal for the proposed feature? I don't want to merge in a configuration option for FieldText until we have a use case backed by an agreed upon feature with some idea of how it is meant to work.

withanage commented 1 year ago

@NateWr thanks for pointing to the #7391 and @Devika008's ui-plan.

@Devika008 we will come back to you , as soon as we have the functional descriptions for the GDPR support.

@NateWr as motivation for adding the functionality as a core-feature, I have taken the orcidProfile plugin use-case and updated the #8850 header with use-case description.