Resetting a field (or a form) doesn't emit an event

Abierto
#1,570 8 comentarios 6 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
react, typescript
Área
frontend

Línea de trabajo

El issue no nombra archivos ni tests; empieza rastreando el punto de entrada resetField y el manejo del listener del campo alrededor de onChange en el ejemplo. Compara el comportamiento de reset con los cambios ordinarios de setValue y, después, identifica los tests de eventos existentes del formulario o del campo que se deben ampliar. Se considera terminado cuando resetear un campo o un formulario produce el evento documentado que necesitan los listeners.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

v1 v2: needs investigation

Hello,
I have a form with a value I sync with my search param.
To make it sync on mount (search param -> form), I use onMount listener of the field.
To make it sync back later (form -> search param), I intend to use onChange for every field change.

But I figured out that clearing a field doesn't actually emit any event I can listen to.
I ended up moving search param reset function to the place where reset actually happens, but I believe the "reset" event might be a thing to have.

My example (simplified):

const formSchema = z.object({
  userId: z.string(),
    // other values
});

type Form = z.infer<typeof formSchema>;

const Component = () => {
  const [searchParamUserId, setSearchParamUserId] = useSearchParam("userId");
  
  const defaultValues: Partial<Form> = {
    userId: undefined,
  };
  
  const form = useAppForm({
    defaultValues: defaultValues as Form,
    validators: {
      onMount: formSchema,
      onChange: formSchema,
      onSubmit: formSchema,
    },
  });
  
  return (
    <form.AppField
      name="userId"
      listeners={{
        onMount: ({ fieldApi }) => {
          if (userId) {
            fieldApi.setValue(searchParamUserId);
          }
        },
        onChange: ({ value }) => setSearchParamUserId(value),
      }}
    >
      {(field) => (
        <UsersSelect
          selected={field.state.value}
          onSelect={(nextUserId) => {
            // Clicking on the same user should reset value to undefined
            if (nextUserId === field.state.value) {
              form.resetField("userId");
              // Unfortunately, resetting field doesn't emit a listener event
              setSearchParamUserId(undefined);
            } else {
              field.setValue(nextUserId);
            }
          }}
        />
      )}
    </form.AppField>
  );
};
Lenguaje dominante
TypeScript
Estrellas
6.8k
Forks
717
Merge medio
5 d 22 h
PR fusionados (30 d)
14

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de TanStack/form

Todos los issues de TanStack/form

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.