gatsby-plugin-next-seo/lib/jsonld/sitelinks-search-box.d.ts

SEO plugin for Gatsby projects

import { FC } from 'react';
import { WebSite } from 'schema-dts';
import { DeferSeoProps } from '../types';
import { Overrides } from '../utils/shared-types';
/**
 * The Sitelinks search box JSON LD component properties.
 *
 * @remarks
 *
 * See
 * {@link https://developers.google.com/search/docs/advanced/structured-data/sitelinks-searchbox | here}
 * for further documentation.
 */
export interface SitelinksSearchBoxJsonLdProps extends DeferSeoProps, Overrides<WebSite> {
    /**
     * The URL of the canonical homepage of the website associated with the Sitelinks search box.
     *
     * @remarks
     *
     * Example: https://example.com
     *
     */
    url: string;
    /**
     * Define the website's search engine query string as a URL.
     *
     * @remarks
     *
     * Example: https://example.com/search?q=
     *
     */
    searchHandlerQueryStringUrl: string;
}
/**
 * The `SitelinksSearchBoxJsonLd` component can be used to add JSON-LD structured data to your website
 * for a Sitelinks search box.
 *
 * @remarks
 *
 * See
 * {@link https://developers.google.com/search/docs/advanced/structured-data/sitelinks-searchbox | here}
 * for further documentation.
 *
 * ```jsx
 * import React from 'react';
 * import { SitelinksSearchBoxJsonLd } from 'gatsby-plugin-next-seo';
 *
 * export default () => (
 *   <>
 *     <h1>Sitelinks Search Box JSON-LD</h1>
 *     <SitelinksSearchBoxJsonLd
 *       url='https://example.com/'
 *       searchHandlerQueryStringUrl='https://example.com/?q='
 *     />
 *   </>
 * );
 * ```
 */
export declare const SitelinksSearchBoxJsonLd: FC<SitelinksSearchBoxJsonLdProps>;
//# sourceMappingURL=sitelinks-search-box.d.ts.map