feat(KtFieldInlineEdit): usable within a form

- with keyboard/mouse controls
> tab away cancels
> enter with focus in the field saves
> enter with focus on the confirm button saves
> clickaway cancels

- readonly mode doesn't allow editing

- emit confirm event on confirmed values

- emit input on edited values

- control isEditing status internally

- prevent confirmation on certain states (error-warning-never)

packages/documentation/data/menu.ts

@@ -9,10 +9,10 @@ import {
 	KtCard,
 	KtComment,
 	KtDrawer,
+	KtFieldInlineEdit,
 	KtFilters,
 	KtForm,
 	KtHeading,
-	KtInlineEdit,
 	KtLine,
 	KtModal,
 	KtNavbar,
@@ -164,8 +164,8 @@ export const menu: Array<Section> = [
 						path: 'form-fields',
 						tags: [Tag.TS, Tag.ZOD],
 					},
+					makeComponentMenuItem(KtFieldInlineEdit),
 					makeComponentMenuItem(KtHeading),
-					makeComponentMenuItem(KtInlineEdit),
 					makeComponentMenuItem(KtLine),
 					{ label: 'Loadings', path: 'loadings', tags: [Tag.CSS] },
 					makeComponentMenuItem(KtModal),

packages/documentation/pages/usage/components/field-inline-edit.vue

@@ -0,0 +1,222 @@
+<template>
+	<div>
+		<ComponentInfo v-bind="{ component }" />
+
+		<div class="element-example white">
+			<KtForm v-model="formValue">
+				<KtFieldInlineEdit
+					v-bind="fieldProps"
+					class="mb-16px"
+					formKey="fieldValue"
+					@confirm="onConfirm"
+				/>
+				<div class="overview__component__value mb-8px">
+					<strong>Value:</strong>
+					<span v-text="JSON.stringify(fieldValue)" />
+					<a @click="reset">reset</a>
+				</div>
+				<div class="overview__component__value mb-16px">
+					<strong>Confirmed Value:</strong>
+					<span v-text="JSON.stringify(confirmedValue)" />
+				</div>
+			</KtForm>
+			<KtForm v-model="settings" size="small">
+				<div class="wrapper">
+					<div>
+						<h4>Settings</h4>
+						<KtFieldSingleSelect
+							formKey="validation"
+							hideClear
+							isOptional
+							label="Validation State"
+							:options="validationOptions"
+						/>
+						<KtFieldSingleSelect
+							formKey="preventConfirmationOn"
+							hideClear
+							isOptional
+							label="preventConfirmationOn"
+							:options="preventConfirmationOptions"
+						/>
+						<KtFieldSingleSelect
+							formKey="textStyle"
+							helpText="Only supported with single-line KtFieldInlineEdit"
+							hideClear
+							:isDisabled="settings.booleanFlags.isMultiline"
+							isOptional
+							label="Text Styles"
+							:options="textStyleOptions"
+						/>
+						<KtFieldToggleGroup
+							formKey="booleanFlags"
+							isOptional
+							label="Boolean Flags"
+							:options="[
+								{ key: 'hideValidation', label: 'hideValidation' },
+								{ key: 'isDisabled', label: 'isDisabled' },
+								{ key: 'isReadonly', label: 'isReadonly' },
+								{ key: 'isLoading', label: 'isLoading' },
+								{ key: 'isMultiline', label: 'isMultiline' },
+								{ key: 'isOptional', label: 'isOptional' },
+							]"
+							type="switch"
+						/>
+						<KtFieldText formKey="placeholder" isOptional label="placeholder" />
+						<KtFieldNumber formKey="tabIndex" isOptional label="tabIndex" />
+						<KtFieldText formKey="dataTest" isOptional label="dataTest" />
+					</div>
+
+					<div>
+						<h4>Texts</h4>
+						<KtFieldText formKey="label" isOptional label="label" />
+						<KtFieldText
+							formKey="helpDescription"
+							isOptional
+							label="helpDescription"
+						/>
+						<div class="field-row">
+							<KtFieldText formKey="helpText" isOptional label="helpText" />
+						</div>
+					</div>
+				</div>
+			</KtForm>
+		</div>
+	</div>
+</template>
+
+<script lang="ts">
+import {
+	Kotti,
+	KtFieldInlineEdit,
+	KtFieldSingleSelect,
+	KtForm,
+} from '@3yourmind/kotti-ui'
+import { KottiFieldInlineEdit } from '@3yourmind/kotti-ui/dist/esm/kotti-field-inline-edit/types'
+import { defineComponent, ref, computed } from '@vue/composition-api'
+
+import ComponentInfo from '~/components/ComponentInfo.vue'
+
+export default defineComponent({
+	name: 'DocumentationPageUsageComponentsFieldInlineEdit',
+	components: {
+		ComponentInfo,
+		KtFieldInlineEdit,
+		KtFieldSingleSelect,
+		KtForm,
+	},
+	setup() {
+		const getInitialValue = () => ({ fieldValue: null })
+
+		const settings = ref<{
+			booleanFlags: {
+				hideValidation: Kotti.FieldToggle.Value
+				isDisabled: Kotti.FieldToggle.Value
+				isLoading: Kotti.FieldToggle.Value
+				isMultiline: Kotti.FieldToggle.Value
+				isOptional: Kotti.FieldToggle.Value
+				isReadonly: Kotti.FieldToggle.Value
+			}
+			dataTest: Kotti.FieldText.Value
+			helpDescription: Kotti.FieldText.Value
+			helpText: Kotti.FieldText.Value
+			label: Kotti.FieldText.Value
+			placeholder: Kotti.FieldText.Value
+			preventConfirmationOn: Kotti.FieldInlineEdit.ConfirmationValidation
+			tabIndex: Kotti.FieldNumber.Value
+			textStyle: Kotti.FieldInlineEdit.TextStyle | null
+			validation: Kotti.Field.Validation.Result['type']
+		}>({
+			booleanFlags: {
+				hideValidation: false,
+				isDisabled: false,
+				isLoading: false,
+				isMultiline: true,
+				isOptional: false,
+				isReadonly: false,
+			},
+			dataTest: null,
+			helpDescription: null,
+			helpText: null,
+			label: 'Label',
+			placeholder: null,
+			preventConfirmationOn: KottiFieldInlineEdit.ConfirmationValidation.ERROR,
+			tabIndex: null,
+			textStyle: null,
+			validation: 'empty',
+		})
+
+		const formValue = ref<{ fieldValue: KottiFieldInlineEdit.Value }>(
+			getInitialValue(),
+		)
+
+		const confirmedValue = ref<KottiFieldInlineEdit.Value>(
+			formValue.value.fieldValue,
+		)
+
+		return {
+			component: KtFieldInlineEdit,
+			confirmedValue,
+			formValue,
+			fieldValue: computed(() => formValue.value.fieldValue),
+			fieldProps: computed(() => ({
+				dataTest: settings.value.dataTest,
+				helpDescription: settings.value.helpDescription,
+				helpText: settings.value.helpText,
+				hideValidation: settings.value.booleanFlags.hideValidation,
+				isDisabled: settings.value.booleanFlags.isDisabled,
+				isLoading: settings.value.booleanFlags.isLoading,
+				isMultiline: settings.value.booleanFlags.isMultiline,
+				isOptional: settings.value.booleanFlags.isOptional,
+				isReadonly: settings.value.booleanFlags.isReadonly,
+				label: settings.value.label,
+				placeholder: settings.value.placeholder,
+				preventConfirmationOn:
+					settings.value.preventConfirmationOn ??
+					Kotti.FieldInlineEdit.ConfirmationValidation.NEVER,
+				tabIndex: settings.value.tabIndex,
+				textStyle: settings.value.textStyle,
+				validator: () => ({
+					type: settings.value.validation ?? 'empty',
+					text: 'Some validation text',
+				}),
+			})),
+			onConfirm: (newVal: Kotti.FieldInlineEdit.Events.Confirm) => {
+				confirmedValue.value = newVal
+			},
+			preventConfirmationOptions: ref(
+				Object.entries(Kotti.FieldInlineEdit.ConfirmationValidation).map(
+					([label, value]) => ({
+						label:
+							label === Kotti.FieldInlineEdit.ConfirmationValidation.NEVER
+								? `${label} (Default)`
+								: label,
+						value,
+					}),
+				),
+			),
+			reset: () => {
+				// needed in the edge case of clicking the reset button while being focused on the field
+				window.setTimeout(() => {
+					formValue.value = getInitialValue()
+					confirmedValue.value = null
+				}, 0)
+			},
+			settings,
+			textStyleOptions: ref([
+				{ label: 'No Styling (DEFAULT)', value: null },
+				...Object.entries(KottiFieldInlineEdit.TextStyle).map(
+					([label, value]) => ({ label, value: value }),
+				),
+			]),
+			validationOptions: ref([
+				{ label: 'Empty (Default)', value: 'empty' },
+				{ label: 'Success', value: 'success' },
+				{ label: 'Warning', value: 'warning' },
+				{ label: 'Error', value: 'error' },
+			]),
+		}
+	},
+})
+</script>
+
+<style src="../styles/form-fields.scss" lang="scss" scoped />

packages/kotti-ui/source/index.ts

@@ -42,6 +42,8 @@ import {
 	KtFieldFileUploadRemote,
 } from './kotti-field-file-upload'
 export * from './kotti-field-file-upload'
+import { KtFieldInlineEdit } from './kotti-field-inline-edit'
+export * from './kotti-field-inline-edit'
 import { KtFieldNumber } from './kotti-field-number'
 export * from './kotti-field-number'
 import { KtFieldPassword } from './kotti-field-password'
@@ -75,8 +77,6 @@ import { KtHeading } from './kotti-heading'
 export * from './kotti-heading'
 import { KtI18nContext } from './kotti-i18n'
 export * from './kotti-i18n'
-import { KtInlineEdit } from './kotti-inline-edit'
-export * from './kotti-inline-edit'
 import { KtLine } from './kotti-line'
 export * from './kotti-line'
 import { KtModal } from './kotti-modal'
@@ -129,6 +129,7 @@ export default {
 			KtFieldDateTimeRange,
 			KtFieldFileUpload,
 			KtFieldFileUploadRemote,
+			KtFieldInlineEdit,
 			KtFieldMultiSelect,
 			KtFieldMultiSelectRemote,
 			KtFieldNumber,
@@ -147,7 +148,6 @@ export default {
 			KtFormSubmit,
 			KtHeading,
 			KtI18nContext,
-			KtInlineEdit,
 			KtLine,
 			KtModal,
 			KtNavbar,