Add the TextInput widget (#518)

* Separate out the number input from a generic field input

* Add TextInput widget

Co-authored-by: mfish33 <32677537+mfish33@users.noreply.github.com>

frontend/src/components/widgets/inputs/CheckboxInput.vue

@@ -88,6 +88,7 @@ import LayoutRow from "@/components/layout/LayoutRow.vue";
 import IconLabel from "@/components/widgets/labels/IconLabel.vue";
 
 export default defineComponent({
+	emits: ["update:checked"],
 	data() {
 		return {
 			id: `${Math.random()}`.substring(2),

frontend/src/components/widgets/inputs/DropdownInput.vue

@@ -98,6 +98,7 @@ declare global {
 }
 
 export default defineComponent({
+	emits: ["update:selectedIndex"],
 	props: {
 		menuEntries: { type: Array as PropType<SectionsOfMenuListEntries>, required: true },
 		selectedIndex: { type: Number as PropType<number>, required: true },

frontend/src/components/widgets/inputs/FieldInput.vue

@@ -0,0 +1,116 @@
+<!-- This is a base component, extended by others like NumberInput and TextInput. It should not be used directly. -->
+<template>
+	<LayoutRow class="field-input" :class="{ disabled }">
+		<input
+			:class="{ 'has-label': label }"
+			:id="`field-input-${id}`"
+			ref="input"
+			type="text"
+			v-model="inputValue"
+			:spellcheck="spellcheck"
+			:disabled="disabled"
+			@focus="() => $emit('textFocused')"
+			@blur="() => $emit('textChanged')"
+			@change="() => $emit('textChanged')"
+			@keydown.enter="() => $emit('textChanged')"
+			@keydown.esc="() => $emit('cancelTextChange')"
+		/>
+		<label v-if="label" :for="`field-input-${id}`">{{ label }}</label>
+		<slot></slot>
+	</LayoutRow>
+</template>
+
+<style lang="scss">
+.field-input {
+	min-width: 80px;
+	height: 24px;
+	position: relative;
+	border-radius: 2px;
+	background: var(--color-1-nearblack);
+	overflow: hidden;
+	flex-direction: row-reverse;
+
+	label {
+		flex: 1 1 100%;
+		line-height: 18px;
+		margin-left: 8px;
+		padding: 3px 0;
+		overflow: hidden;
+		text-overflow: ellipsis;
+	}
+
+	&:not(.disabled) label {
+		cursor: text;
+	}
+
+	input {
+		flex: 1 1 100%;
+		width: 0;
+		min-width: 30px;
+		height: 18px;
+		line-height: 18px;
+		margin: 0 8px;
+		padding: 3px 0;
+		outline: none;
+		border: none;
+		background: none;
+		color: var(--color-e-nearwhite);
+		text-align: center;
+
+		&:not(:focus).has-label {
+			text-align: right;
+			margin-left: 0;
+			margin-right: 8px;
+		}
+
+		&:focus {
+			text-align: left;
+
+			& + label {
+				display: none;
+			}
+		}
+	}
+
+	&.disabled {
+		background: var(--color-2-mildblack);
+
+		label,
+		input {
+			color: var(--color-8-uppergray);
+		}
+	}
+}
+</style>
+
+<script lang="ts">
+import { defineComponent, PropType } from "vue";
+
+import LayoutRow from "@/components/layout/LayoutRow.vue";
+
+export default defineComponent({
+	emits: ["update:value", "textFocused", "textChanged", "cancelTextChange"],
+	props: {
+		value: { type: String as PropType<string>, required: true },
+		label: { type: String as PropType<string>, required: false },
+		spellcheck: { type: Boolean as PropType<boolean>, default: false },
+		disabled: { type: Boolean as PropType<boolean>, default: false },
+	},
+	data() {
+		return {
+			id: `${Math.random()}`.substring(2),
+		};
+	},
+	computed: {
+		inputValue: {
+			get() {
+				return this.value;
+			},
+			set(value: string) {
+				this.$emit("update:value", value);
+			},
+		},
+	},
+	components: { LayoutRow },
+});
+</script>

frontend/src/components/widgets/inputs/MenuBarInput.vue

@@ -1,12 +1,12 @@
 <template>
 	<div class="menu-bar-input">
 		<div class="entry-container">
-			<div @click="visitWebsite('https://www.graphite.design')" class="entry">
+			<div @click="() => visitWebsite('https://www.graphite.design')" class="entry">
 				<IconLabel :icon="'GraphiteLogo'" />
 			</div>
 		</div>
 		<div class="entry-container" v-for="(entry, index) in menuEntries" :key="index">
-			<div @click="handleEntryClick(entry)" class="entry" :class="{ open: entry.ref && entry.ref.isOpen() }" data-hover-menu-spawner>
+			<div @click="() => handleEntryClick(entry)" class="entry" :class="{ open: entry.ref && entry.ref.isOpen() }" data-hover-menu-spawner>
 				<IconLabel :icon="entry.icon" v-if="entry.icon" />
 				<span v-if="entry.label">{{ entry.label }}</span>
 			</div>

frontend/src/components/widgets/inputs/NumberInput.vue

@@ -1,73 +1,24 @@
 <template>
-	<LayoutRow class="number-input" :class="{ disabled }">
-		<input
-			:class="{ 'has-label': label }"
-			:id="`number-input-${id}`"
-			type="text"
-			spellcheck="false"
-			v-model="text"
-			@change="onTextChanged()"
-			@keydown.esc="onCancelTextChange"
-			ref="input"
-			:disabled="disabled"
-		/>
-		<label v-if="label" :for="`number-input-${id}`">{{ label }}</label>
-		<button v-if="!Number.isNaN(value)" class="arrow left" @click="onIncrement('Decrease')"></button>
-		<button v-if="!Number.isNaN(value)" class="arrow right" @click="onIncrement('Increase')"></button>
-	</LayoutRow>
+	<FieldInput
+		class="number-input"
+		v-model:value="text"
+		:label="label"
+		:spellcheck="false"
+		:disabled="disabled"
+		@textFocused="() => onTextFocused()"
+		@textChanged="() => onTextChanged()"
+		@cancelTextChange="() => onCancelTextChange()"
+		ref="fieldInput"
+	>
+		<button v-if="!Number.isNaN(value)" class="arrow left" @click="() => onIncrement('Decrease')"></button>
+		<button v-if="!Number.isNaN(value)" class="arrow right" @click="() => onIncrement('Increase')"></button>
+	</FieldInput>
 </template>
 
 <style lang="scss">
 .number-input {
-	min-width: 80px;
-	height: 24px;
-	position: relative;
-	border-radius: 2px;
-	background: var(--color-1-nearblack);
-	overflow: hidden;
-	flex-direction: row-reverse;
-
-	label {
-		flex: 1 1 100%;
-		line-height: 18px;
-		margin-left: 8px;
-		padding: 3px 0;
-		overflow: hidden;
-		text-overflow: ellipsis;
-	}
-
-	&:not(.disabled) label {
-		cursor: text;
-	}
-
-	input {
-		flex: 1 1 100%;
-		width: 0;
-		min-width: 30px;
-		height: 18px;
-		line-height: 18px;
-		margin: 0 8px;
-		padding: 3px 0;
-		outline: none;
-		border: none;
-		background: none;
-		color: var(--color-e-nearwhite);
-		text-align: center;
-
-		&:not(:focus).has-label {
-			text-align: right;
-			margin-left: 0;
-			margin-right: 8px;
-		}
-
-		&:focus {
-			text-align: left;
-
-			& + label,
-			& ~ .arrow {
-				display: none;
-			}
-		}
+	input:focus ~ .arrow {
+		display: none;
 	}
 
 	&:not(:hover) .arrow {
@@ -127,17 +78,8 @@
 		}
 	}
 
-	&.disabled {
-		background: var(--color-2-mildblack);
-
-		label,
-		input {
-			color: var(--color-8-uppergray);
-		}
-
-		.arrow {
-			display: none;
-		}
+	&.disabled .arrow {
+		display: none;
 	}
 }
 </style>
@@ -147,9 +89,10 @@ import { defineComponent, PropType } from "vue";
 
 import { IncrementBehavior, IncrementDirection } from "@/utilities/widgets";
 
-import LayoutRow from "@/components/layout/LayoutRow.vue";
+import FieldInput from "@/components/widgets/inputs/FieldInput.vue";
 
 export default defineComponent({
+	emits: ["update:value"],
 	props: {
 		value: { type: Number as PropType<number>, required: true },
 		min: { type: Number as PropType<number>, required: false },
@@ -167,9 +110,8 @@ export default defineComponent({
 	},
 	data() {
 		return {
-			text: this.generateText(this.value),
+			text: this.displayText(this.value),
 			editing: false,
-			id: `${Math.random()}`.substring(2),
 		};
 	},
 	methods: {
@@ -177,8 +119,10 @@ export default defineComponent({
 			if (Number.isNaN(this.value)) this.text = "";
 			else if (this.unitIsHiddenWhenEditing) this.text = `${this.value}`;
 			else this.text = `${this.value}${this.unit}`;
+
 			this.editing = true;
-			const inputElement = this.$refs.input as HTMLInputElement;
+
+			const inputElement = (this.$refs.fieldInput as typeof FieldInput).$refs.input as HTMLInputElement;
 			// Setting the value directly is required to make `inputElement.select()` work
 			inputElement.value = this.text;
 			inputElement.select();
@@ -187,59 +131,66 @@ export default defineComponent({
 		// enter key (via the `change` event) or when the <input> element is defocused (with the `blur` event binding)
 		onTextChanged() {
 			// The `inputElement.blur()` call at the bottom of this function causes itself to be run again, so this check skips a second run
-			if (!this.editing) return;
-			const newValue = parseFloat(this.text);
-			this.updateValue(newValue);
-			this.editing = false;
-			const inputElement = this.$refs.input as HTMLElement;
-			inputElement.blur();
+			if (this.editing) {
+				const newValue = parseFloat(this.text);
+				this.updateValue(newValue);
+
+				this.editing = false;
+
+				const inputElement = (this.$refs.fieldInput as typeof FieldInput).$refs.input as HTMLInputElement;
+				inputElement.blur();
+			}
 		},
 		onCancelTextChange() {
 			this.updateValue(NaN);
+
 			this.editing = false;
-			const inputElement = this.$refs.input as HTMLElement;
+
+			const inputElement = (this.$refs.fieldInput as typeof FieldInput).$refs.input as HTMLInputElement;
 			inputElement.blur();
 		},
 		onIncrement(direction: IncrementDirection) {
 			if (Number.isNaN(this.value)) return;
-			switch (this.incrementBehavior) {
-				case "Add": {
+
+			({
+				Add: (): void => {
 					const directionAddend = direction === "Increase" ? this.incrementFactor : -this.incrementFactor;
 					this.updateValue(this.value + directionAddend);
-					break;
-				}
-				case "Multiply": {
+				},
+				Multiply: (): void => {
 					const directionMultiplier = direction === "Increase" ? this.incrementFactor : 1 / this.incrementFactor;
 					this.updateValue(this.value * directionMultiplier);
-					break;
-				}
-				case "Callback": {
+				},
+				Callback: (): void => {
 					if (direction === "Increase" && this.incrementCallbackIncrease) this.incrementCallbackIncrease();
 					if (direction === "Decrease" && this.incrementCallbackDecrease) this.incrementCallbackDecrease();
-					break;
-				}
-				default:
-					break;
-			}
+				},
+				None: (): void => undefined,
+			}[this.incrementBehavior]());
 		},
 		updateValue(newValue: number) {
-			let sanitized = newValue;
 			const invalid = Number.isNaN(newValue);
+
+			let sanitized = newValue;
 			if (invalid) sanitized = this.value;
 			if (this.isInteger) sanitized = Math.round(sanitized);
 			if (typeof this.min === "number" && !Number.isNaN(this.min)) sanitized = Math.max(sanitized, this.min);
 			if (typeof this.max === "number" && !Number.isNaN(this.max)) sanitized = Math.min(sanitized, this.max);
+
 			if (!invalid) this.$emit("update:value", sanitized);
-			this.text = this.generateText(sanitized);
+
+			this.text = this.displayText(sanitized);
 		},
-		generateText(value: number): string {
+		displayText(value: number): string {
 			// Find the amount of digits on the left side of the decimal
 			// 10.25 == 2
 			// 1.23 == 1
-			// 0.23 == 0 (Reason for the slightly more complicated code)
+			// 0.23 == 0 (reason for the slightly more complicated code)
 			const leftSideDigits = Math.max(Math.floor(value).toString().length, 0) * Math.sign(value);
 			const roundingPower = 10 ** Math.max(this.displayDecimalPlaces - leftSideDigits, 0);
+
 			const displayValue = Math.round(value * roundingPower) / roundingPower;
+
 			return `${displayValue}${this.unit}`;
 		},
 	},
@@ -250,23 +201,15 @@ export default defineComponent({
 				this.text = "-";
 				return;
 			}
+
 			// The simple `clamp()` function can't be used here since `undefined` values need to be boundless
 			let sanitized = newValue;
 			if (typeof this.min === "number") sanitized = Math.max(sanitized, this.min);
 			if (typeof this.max === "number") sanitized = Math.min(sanitized, this.max);
-			this.text = this.generateText(sanitized);
+
+			this.text = this.displayText(sanitized);
 		},
 	},
-	mounted() {
-		const inputElement = this.$refs.input as HTMLInputElement;
-		inputElement.addEventListener("focus", this.onTextFocused);
-		inputElement.addEventListener("blur", this.onTextChanged);
-	},
-	beforeUnmount() {
-		const inputElement = this.$refs.input as HTMLInputElement;
-		inputElement.removeEventListener("focus", this.onTextFocused);
-		inputElement.removeEventListener("blur", this.onTextChanged);
-	},
-	components: { LayoutRow },
+	components: { FieldInput },
 });
 </script>

frontend/src/components/widgets/inputs/OptionalInput.vue

@@ -41,6 +41,7 @@ import LayoutRow from "@/components/layout/LayoutRow.vue";
 import CheckboxInput from "@/components/widgets/inputs/CheckboxInput.vue";
 
 export default defineComponent({
+	emits: ["update:checked"],
 	props: {
 		checked: { type: Boolean as PropType<boolean>, required: true },
 		icon: { type: String as PropType<IconName>, default: "Checkmark" },

frontend/src/components/widgets/inputs/RadioInput.vue

@@ -1,6 +1,6 @@
 <template>
 	<LayoutRow class="radio-input">
-		<button :class="{ active: index === selectedIndex }" v-for="(entry, index) in entries" :key="index" @click="handleEntryClick(entry)" :title="entry.tooltip">
+		<button :class="{ active: index === selectedIndex }" v-for="(entry, index) in entries" :key="index" @click="() => handleEntryClick(entry)" :title="entry.tooltip">
 			<IconLabel v-if="entry.icon" :icon="entry.icon" />
 			<TextLabel v-if="entry.label">{{ entry.label }}</TextLabel>
 		</button>
@@ -81,6 +81,7 @@ export interface RadioEntryData {
 export type RadioEntries = RadioEntryData[];
 
 export default defineComponent({
+	emits: ["update:selectedIndex"],
 	props: {
 		entries: { type: Array as PropType<RadioEntries>, required: true },
 		selectedIndex: { type: Number as PropType<number>, required: true },

frontend/src/components/widgets/inputs/TextInput.vue

@@ -0,0 +1,68 @@
+<template>
+	<FieldInput
+		class="text-input"
+		v-model:value="text"
+		:label="label"
+		:spellcheck="true"
+		:disabled="disabled"
+		@textFocused="() => onTextFocused()"
+		@textChanged="() => onTextChanged()"
+		@cancelTextChange="() => onCancelTextChange()"
+		ref="fieldInput"
+	></FieldInput>
+</template>
+
+<style lang="scss"></style>
+
+<script lang="ts">
+import { defineComponent, PropType } from "vue";
+
+import FieldInput from "@/components/widgets/inputs/FieldInput.vue";
+
+export default defineComponent({
+	emits: ["update:value"],
+	props: {
+		value: { type: String as PropType<string>, required: true },
+		label: { type: String as PropType<string>, required: false },
+		disabled: { type: Boolean as PropType<boolean>, default: false },
+	},
+	data() {
+		return {
+			editing: false,
+		};
+	},
+	computed: {
+		text: {
+			get() {
+				return this.value;
+			},
+			set(value: string) {
+				this.$emit("update:value", value);
+			},
+		},
+	},
+	methods: {
+		onTextFocused() {
+			this.editing = true;
+
+			const inputElement = (this.$refs.fieldInput as typeof FieldInput).$refs.input as HTMLInputElement;
+			// Setting the value directly is required to make `inputElement.select()` work
+			inputElement.value = this.text;
+			inputElement.select();
+		},
+		// Called only when `value` is changed from the <input> element via user input and committed, either with the
+		// enter key (via the `change` event) or when the <input> element is defocused (with the `blur` event binding)
+		onTextChanged() {
+			// The `inputElement.blur()` call in `onCancelTextChange()` causes itself to be run again, so this if statement skips a second run
+			if (this.editing) this.onCancelTextChange();
+		},
+		onCancelTextChange() {
+			this.editing = false;
+
+			const inputElement = (this.$refs.fieldInput as typeof FieldInput).$refs.input as HTMLInputElement;
+			inputElement.blur();
+		},
+	},
+	components: { FieldInput },
+});
+</script>