Hooks
useQuery

useQuery

El hook useQuery permite gestionar los parámetros de consulta en la URL, incluyendo su actualización, eliminación y verificación de cambios en Next.js.

Importación

Para importar el componente useQuery, se puede hacer desde fenextjs

import { useQuery } from "fenextjs";

Parámetros

ParámetroTipoRequeridoDefaultDescripcion
ignoreQuerys[id: keyof useQuery_QueryProps]noLista opcional de claves de consulta que deben ignorarse al obtener los parámetros de la URL.

Returns

ParametroTipoDescripcion
loadbooleanIndica si el enrutador (router) está listo.
queryuseQuery_QueryPropsObjeto que contiene los parámetros de consulta de la URL, mapeados y procesados.
setQuery(query: useQuery_QueryProps) => booleanFunción que establece los parámetros de consulta en la URL.
onConcatQuery(newQuery: useQuery_QueryProps) => booleanFunción que concatena nuevos parámetros de consulta con los existentes y actualiza la URL.
onChangeQuery(id: keyof useQuery_QueryProps) => (value: any) => booleanFunción que retorna un manejador de eventos para actualizar un parámetro específico de consulta en la URL.
onDeleteQuery(id: keyof useQuery_QueryProps) => booleanFunción que elimina un parámetro específico de consulta de la URL.
isChangebooleanIndica si los parámetros de consulta han cambiado desde la última vez.

Usos

  • Uso básico de useQuery
const {
  query,
  setQuery,
  onConcatQuery,
  onChangeQuery,
  onDeleteQuery,
  isChange,
} = useQuery({
  ignoreQuerys: ["tab", "page"],
});
 
// Actualizar un parámetro específico
onChangeQuery("search")("new search term");
 
// Agregar varios parámetros
onConcatQuery({ page: 2, order: "asc" });
 
// Eliminar un parámetro específico
onDeleteQuery("order");
 
console.log(query); // Muestra los parámetros de consulta actuales