From 28f965fd1b85d91d53165efb96e7346eb6ebdb8d Mon Sep 17 00:00:00 2001
From: ipula <ipula.ranasinghe@tib.eu>
Date: Tue, 28 Mar 2023 10:56:18 +0200
Subject: [PATCH] pkp/pkp-lib#8850 Add disabled property for form text in
 ui-library

---
 src/components/Form/fields/FieldBase.vue      |  1 +
 src/components/Form/fields/FieldText.vue      | 20 +++++++-------
 .../Form/fields/FieldBase/readme.md           |  1 +
 .../fields/FieldText/ComponentFieldText.vue   |  7 +++++
 .../previews/PreviewFieldTextDisable.vue      | 27 +++++++++++++++++++
 .../previews/PreviewFieldTextOptIntoEdit.vue  | 10 +++++++
 .../Form/helpers/field-text-given-name.js     |  1 +
 7 files changed, 56 insertions(+), 11 deletions(-)
 create mode 100644 src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextDisable.vue

diff --git a/src/components/Form/fields/FieldBase.vue b/src/components/Form/fields/FieldBase.vue
index fbf8f97b1..5f2e3d4e8 100644
--- a/src/components/Form/fields/FieldBase.vue
+++ b/src/components/Form/fields/FieldBase.vue
@@ -26,6 +26,7 @@ export default {
 		formId: String,
 		isMultilingual: Boolean,
 		isRequired: Boolean,
+		disabled: Boolean,
 		showWhen: [String, Array],
 		primaryLocale: String,
 		localeKey: String,
diff --git a/src/components/Form/fields/FieldText.vue b/src/components/Form/fields/FieldText.vue
index acf00abce..d0debc4c3 100644
--- a/src/components/Form/fields/FieldText.vue
+++ b/src/components/Form/fields/FieldText.vue
@@ -46,14 +46,13 @@
 					:name="localizedName"
 					:aria-describedby="describedByIds"
 					:aria-invalid="errors && errors.length"
-					:disabled="isDisabled"
+					:disabled="disabled"
 					:required="isRequired"
 					:style="inputStyles"
 				/>
 				<span
 					v-if="prefix"
 					class="pkpFormField__inputPrefix"
-					v-html="prefix"
 					ref="prefix"
 					:style="prefixStyles"
 					@click="setFocus"
@@ -65,9 +64,9 @@
 					:total="locales.length"
 				/>
 				<pkp-button
-					v-if="optIntoEdit && isDisabled"
+					v-if="optIntoEdit && disabled"
 					class="pkpFormField--text__optIntoEdit"
-					@click="isDisabled = false"
+					@click="enable()"
 				>
 					{{ optIntoEditLabel }}
 				</pkp-button>
@@ -80,7 +79,6 @@
 		</div>
 	</div>
 </template>
-
 <script>
 import FieldBase from './FieldBase.vue';
 
@@ -102,7 +100,6 @@ export default {
 	data() {
 		return {
 			inputStyles: {},
-			isDisabled: false,
 			prefixStyles: {},
 		};
 	},
@@ -143,6 +140,12 @@ export default {
 		setFocus() {
 			this.$refs.input.focus();
 		},
+		/**
+		 * Set disable prop false
+		 */
+		enable() {
+			this.$emit('change', this.disabled, 'disabled', false);
+		},
 	},
 	mounted() {
 		/**
@@ -194,11 +197,6 @@ export default {
 				}
 			}, 700);
 		});
-
-		// Set the field to disabled if optIntoEdit is passed
-		if (this.optIntoEdit) {
-			this.isDisabled = true;
-		}
 	},
 };
 </script>
diff --git a/src/docs/components/Form/fields/FieldBase/readme.md b/src/docs/components/Form/fields/FieldBase/readme.md
index fb7dbb2b7..a1ec4a635 100644
--- a/src/docs/components/Form/fields/FieldBase/readme.md
+++ b/src/docs/components/Form/fields/FieldBase/readme.md
@@ -12,6 +12,7 @@
 | `groupId` | The ID of the group this field should appear in. |
 | `formId` | The ID of the form this field should appear in. This is passed down from the `Form`. |
 | `isRequired` | Whether or not a value for this field should be required. |
+| `disabled` | Used in the `disabled` attribute of `<input>`, `<textarea>`, `<select>` and other fields. |
 | `isMultilingual` | Whether or not this field should be presented for each supported language. |
 | `localeKey` | If the field `isMultilingual`, this will be set to the locale key of this particular instance. This is passed down from the `Form`. |
 | `primaryLocale` | The primary locale for this form. This is passed down from the `Form`. |
diff --git a/src/docs/components/Form/fields/FieldText/ComponentFieldText.vue b/src/docs/components/Form/fields/FieldText/ComponentFieldText.vue
index 89468cdd2..49f39a782 100644
--- a/src/docs/components/Form/fields/FieldText/ComponentFieldText.vue
+++ b/src/docs/components/Form/fields/FieldText/ComponentFieldText.vue
@@ -10,6 +10,8 @@ import PreviewFieldTextPrefix from './previews/PreviewFieldTextPrefix.vue';
 import PreviewFieldTextPrefixTemplate from '!raw-loader!./previews/PreviewFieldTextPrefix.vue';
 import PreviewFieldTextOptIntoEdit from './previews/PreviewFieldTextOptIntoEdit.vue';
 import PreviewFieldTextOptIntoEditTemplate from '!raw-loader!./previews/PreviewFieldTextOptIntoEdit.vue';
+import PreviewFieldTextDisable from './previews/PreviewFieldTextDisable.vue';
+import PreviewFieldTextDisableTemplate from '!raw-loader!./previews/PreviewFieldTextDisable.vue';
 import readme from '!raw-loader!./readme.md';
 
 export default {
@@ -45,6 +47,11 @@ export default {
 					name: 'Editing Opt-in',
 					template: this.extractTemplate(PreviewFieldTextOptIntoEditTemplate),
 				},
+				{
+					component: PreviewFieldTextDisable,
+					name: 'Disable',
+					template: this.extractTemplate(PreviewFieldTextDisableTemplate),
+				},
 			],
 		};
 	},
diff --git a/src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextDisable.vue b/src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextDisable.vue
new file mode 100644
index 000000000..87158b7d3
--- /dev/null
+++ b/src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextDisable.vue
@@ -0,0 +1,27 @@
+<template>
+	<field-text v-bind="field" @change="change" label="Disable" />
+</template>
+
+<script>
+import FieldText from '@/components/Form/fields/FieldText.vue';
+import PreviewFieldBase from '../../FieldBase/previews/PreviewFieldBase.vue';
+import fieldBase from '../../../helpers/field-base';
+import field from '../../../helpers/field-text-given-name';
+
+export default {
+	extends: PreviewFieldBase,
+	components: {
+		FieldText,
+	},
+	data() {
+		return {
+			field: {
+				...fieldBase,
+				...field,
+				isRequired: false,
+				disabled: true,
+			},
+		};
+	},
+};
+</script>
diff --git a/src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextOptIntoEdit.vue b/src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextOptIntoEdit.vue
index 083312e6c..94b9587d2 100644
--- a/src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextOptIntoEdit.vue
+++ b/src/docs/components/Form/fields/FieldText/previews/PreviewFieldTextOptIntoEdit.vue
@@ -25,8 +25,18 @@ export default {
 				...fieldBase,
 				...field,
 				isRequired: false,
+				disabled: true,
 			},
 		};
 	},
+	methods: {
+		change(name, prop, newValue, localeKey) {
+			if (localeKey) {
+				this.field[prop][localeKey] = newValue;
+			} else {
+				this.field[prop] = newValue;
+			}
+		},
+	},
 };
 </script>
diff --git a/src/docs/components/Form/helpers/field-text-given-name.js b/src/docs/components/Form/helpers/field-text-given-name.js
index 266ee423e..0ff7a00c8 100644
--- a/src/docs/components/Form/helpers/field-text-given-name.js
+++ b/src/docs/components/Form/helpers/field-text-given-name.js
@@ -4,5 +4,6 @@ export default {
 	inputType: 'text',
 	label: 'Given Name',
 	isRequired: true,
+	disabled: false,
 	value: '',
 };