@prismicio/react/dist/PrismicToolbar.d.ts

React components and hooks to fetch and present Prismic content

import { FC } from "react";

//#region src/PrismicToolbar.d.ts
/** Props for `<PrismicToolbar>`. */
type PrismicToolbarProps = {
  /**
   * The name of the Prismic repository. For example, `"my-repo"` if the repository URL is
   * `my-repo.prismic.io`.
   */
  repositoryName: string;
  /**
   * Called when the Prismic toolbar triggers a preview update. This happens when the previewed
   * content changes.
   *
   * The new ref can be read from `event.detail.ref`.
   *
   * The default page reload behavior can be cancelled with `event.preventDefault()`.
   */
  onPreviewUpdate?: (event: CustomEvent<{
    ref: string;
  }>) => void;
  /**
   * Called when the Prismic toolbar triggers a preview end. This happens when a preview session is
   * closed.
   *
   * The default page reload behavior can be cancelled with `event.preventDefault()`.
   */
  onPreviewEnd?: (event: CustomEvent<null>) => void;
};
/**
 * Renders the Prismic Toolbar script to support draft previews.
 *
 * @example
 * 	```tsx
 * 	<PrismicToolbar repositoryName="my-repo" />;
 * 	```
 *
 * @see Learn how to set up preview functionality and the toolbar's role in preview sessions: {@link https://prismic.io/docs/previews}
 */
declare const PrismicToolbar: FC<PrismicToolbarProps>;
//#endregion
export { PrismicToolbar, PrismicToolbarProps };
//# sourceMappingURL=PrismicToolbar.d.ts.map