import type { Breadcrumb, ContentsDate, Publisher } from '../types/index.js'; import type { ReactElement } from 'react'; import type { SEOMetadata } from '@farfetch/blackout-client'; /** * Generate Structured Data (JSON-LD) for an Article. * * @example * ``` * import { structuredArticle } from '@farfetch/blackout-react'; * * * {structuredArticle( * metadata, * { * publicationDate: '...', * modificationDate: '...', * }, * pathname, * title, * image, * author, * breadcrumbsList, * publisher: { * name: '...', * url: '...', * logo: '...', * }, * 2 * )} * * ``` * * @param metadata - All SEO metadata for the Article. * @param date - All information about Article date. * @param url - Relative url of the page (location.pathname). * @param title - Title of the first component in the Page (e.g. Hero Title, or H1). * @param image - Image URL to describe the content of the Page. * @param author - Author name of the Article. * @param breadcrumbs - Breadcrumbs list with all url Texts. * @param publisher - Object with publisher data. * @param space - Add whitespace and indentation to the serialized output. * * @returns - A script tag with Article JSON-LD structured data. */ declare const structuredArticle: (metadata: SEOMetadata, date: ContentsDate, url: string, title: string, image: string, author: string, breadcrumbs: Breadcrumb[], publisher: Publisher, space?: number) => ReactElement; export default structuredArticle;