remix-utils/build/react/existing-search-params.d.ts

This package contains simple utility functions to use with [React Router](https://reactrouter.com/).

import * as React from "react";
type Props = {
    /**
     * These query params will not be included as hidden inputs.
     *  - add params handled by this form to this list
     *  - any params from other forms you want to clear on submit
     */
    exclude?: Array<string | undefined>;
} & Omit<React.InputHTMLAttributes<HTMLInputElement>, "name" | "value" | "type" | "id">;
/**
 * Include existing query params as hidden inputs in a form.
 *
 * @example
 * A pagination bar that does not clear the search query
 * ```tsx
 * <Form>
 *   <ExistingSearchParams exclude={['page']} />
 *   <button type="submit" name="page" value="1">1</button>
 *   <button type="submit" name="page" value="2">2</button>
 *   <button type="submit" name="page" value="3">3</button>
 * </Form>
 * ```
 *
 * @example
 * A search form that clears the page param
 * ```tsx
 * <Form>
 *   <ExistingSearchParams exclude={['q', 'page']} />
 *   <input type="search" name="q" />
 * </Form>
 * ```
 */
export declare function ExistingSearchParams({ exclude, ...props }: Props): import("react/jsx-runtime").JSX.Element;
export {};