add isPrefilled arg (#859)

Normally, the nameEmpty error is not displayed when the field is empty. However, in the specific case where the field is automatically populated when a source file is selected, the nameEmpty error should be shown if the field is cleared after auto-completion. This behavior is controlled by the isPrefilled argument. Put it to true in the component calling use-unique-name-validation to activate this logic.

(Not: currently, the validation checks whether the entire form is dirty, rather than just tracking whether the file selection (which triggers auto-completion) has changed.)

Author: carojeandat

src/components/inputs/reactHookForm/text/UniqueNameInput.tsx

@@ -27,6 +27,7 @@ export interface UniqueNameInputProps {
     >;
     activeDirectory?: UUID;
     currentName?: string;
+    isPrefilled?: boolean;
     sx?: SxStyle;
     fullWidth?: boolean;
 }
@@ -42,6 +43,7 @@ export function UniqueNameInput({
     onManualChangeCallback,
     formProps,
     currentName = '',
+    isPrefilled = false,
     activeDirectory,
     sx,
     fullWidth = true,
@@ -58,6 +60,7 @@ export function UniqueNameInput({
         currentName,
         elementType,
         activeDirectory,
+        isPrefilled,
     });
 
     // Handle on user's change

src/hooks/use-unique-name-validation.ts

@@ -18,6 +18,7 @@ interface UseUniqueNameValidationParams {
     elementType: ElementType;
     activeDirectory?: string;
     elementExists?: (directory: UUID, name: string, type: ElementType) => Promise<boolean>;
+    isPrefilled?: boolean;
 }
 
 export function useUniqueNameValidation({
@@ -26,6 +27,7 @@ export function useUniqueNameValidation({
     elementType,
     activeDirectory,
     elementExists = elementAlreadyExists,
+    isPrefilled = false,
 }: UseUniqueNameValidationParams) {
     const {
         setError,
@@ -36,6 +38,7 @@ export function useUniqueNameValidation({
 
     const {
         field: { value },
+        fieldState: { isDirty: fieldIsDirty },
     } = useController({ name });
 
     const {
@@ -92,14 +95,20 @@ export function useUniqueNameValidation({
             debouncedHandleCheckName(trimmedValue);
         }
 
-        // if the form is unchanged, we don't do custom validation
-        if (!formIsDirty) {
+        // if the name is unchanged, we don't do custom validation
+        if (!isPrefilled && !fieldIsDirty) {
             clearErrors(name);
             return;
         }
-        if (trimmedValue === defaultFieldValue && trimmedValue.length > 0) {
+        if (isPrefilled && !formIsDirty) {
+            clearErrors(name);
             return;
         }
+
+        if (isPrefilled && trimmedValue === defaultFieldValue && trimmedValue.length > 0) {
+            return;
+        }
+
         if (trimmedValue) {
             clearErrors(name);
             setError('root.isValidating', {
@@ -120,7 +129,9 @@ export function useUniqueNameValidation({
         setError,
         clearErrors,
         name,
+        fieldIsDirty,
         formIsDirty,
+        isPrefilled,
         defaultFieldValue,
         directory,
         selectedDirectory,