@prismicio/react 2.5.1 → 2.5.2

package/dist/PrismicRichText.d.ts

@@ -1,116 +1,116 @@
-import * as React from "react";
-import * as prismicT from "@prismicio/types";
-import * as prismicH from "@prismicio/helpers";
-import { JSXFunctionSerializer, JSXMapSerializer } from "./types";
-import { PrismicLinkProps } from "./PrismicLink";
-/**
- * Props for `<PrismicRichText>`.
- */
-export type PrismicRichTextProps<LinkResolverFunction extends prismicH.LinkResolverFunction<any> = prismicH.LinkResolverFunction> = {
-    /**
-     * The Prismic Rich Text field to render.
-     */
-    field: prismicT.RichTextField | null | undefined;
-    /**
-     * The Link Resolver used to resolve links.
-     *
-     * @remarks
-     * If your app uses Route Resolvers when querying for your Prismic
-     * repository's content, a Link Resolver does not need to be provided.
-     * @see Learn about Link Resolvers and Route Resolvers {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver}
-     */
-    linkResolver?: LinkResolverFunction;
-    /**
-     * A function that maps a Rich Text block to a React component.
-     *
-     * @deprecated Use the `components` prop instead. Prefer using a map
-     *   serializer when possible.
-     * @see Learn about Rich Text serializers {@link https://prismic.io/docs/core-concepts/html-serializer}
-     */
-    htmlSerializer?: JSXFunctionSerializer;
-    /**
-     * A map or function that maps a Rich Text block to a React component.
-     *
-     * @remarks
-     * Prefer using a map serializer over the function serializer when possible.
-     * The map serializer is simpler to maintain.
-     * @example A map serializer.
-     *
-     * ```jsx
-     * {
-     *   heading1: ({children}) => <Heading>{children}</Heading>
-     * }
-     * ```
-     *
-     * @example A function serializer.
-     *
-     * ```jsx
-     * (type, node, content, children) => {
-     * 	switch (type) {
-     * 		case "heading1": {
-     * 			return <Heading>{children}</Heading>;
-     * 		}
-     * 	}
-     * };
-     * ```
-     */
-    components?: JSXMapSerializer | JSXFunctionSerializer;
-    /**
-     * The React component rendered for links when the URL is internal.
-     *
-     * @defaultValue `<a>`
-     */
-    internalLinkComponent?: PrismicLinkProps["internalComponent"];
-    /**
-     * The React component rendered for links when the URL is external.
-     *
-     * @defaultValue `<a>`
-     */
-    externalLinkComponent?: PrismicLinkProps["externalComponent"];
-    /**
-     * The value to be rendered when the field is empty. If a fallback is not
-     * given, `null` will be rendered.
-     */
-    fallback?: React.ReactNode;
-};
-/**
- * React component that renders content from a Prismic Rich Text field. By
- * default, HTML elements are rendered for each piece of content. A `heading1`
- * block will render an `<h1>` HTML element, for example. Links will use
- * `<PrismicLink>` by default which can be customized using the
- * `internalLinkComponent` and `externalLinkComponent` props.
- *
- * To customize the components that are rendered, provide a map or function
- * serializer to the `components` prop.
- *
- * Components can also be provided in a centralized location using the
- * `<PrismicProvider>` React context provider.
- *
- * @remarks
- * This component returns a React fragment with no wrapping element around the
- * content. If you need a wrapper, add a component around `<PrismicRichText>`.
- * @example Rendering a Rich Text field using the default HTMl elements.
- *
- * ```jsx
- * <PrismicRichText field={document.data.content} />;
- * ```
- *
- * @example Rendering a Rich Text field using a custom set of React components.
- *
- * ```jsx
- * <PrismicRichText
- * 	field={document.data.content}
- * 	components={{
- * 		heading1: ({ children }) => <Heading>{children}</Heading>,
- * 	}}
- * />;
- * ```
- *
- * @param props - Props for the component.
- *
- * @returns The Rich Text field's content as React components.
- *
- * @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
- * @see Learn about Rich Text serializers {@link https://prismic.io/docs/core-concepts/html-serializer}
- */
-export declare const PrismicRichText: <LinkResolverFunction extends prismicH.LinkResolverFunction<any> = prismicH.LinkResolverFunction<string>>(props: PrismicRichTextProps<LinkResolverFunction>) => JSX.Element | null;
+import * as React from "react";
+import * as prismicT from "@prismicio/types";
+import * as prismicH from "@prismicio/helpers";
+import { JSXFunctionSerializer, JSXMapSerializer } from "./types";
+import { PrismicLinkProps } from "./PrismicLink";
+/**
+ * Props for `<PrismicRichText>`.
+ */
+export type PrismicRichTextProps<LinkResolverFunction extends prismicH.LinkResolverFunction<any> = prismicH.LinkResolverFunction> = {
+    /**
+     * The Prismic Rich Text field to render.
+     */
+    field: prismicT.RichTextField | null | undefined;
+    /**
+     * The Link Resolver used to resolve links.
+     *
+     * @remarks
+     * If your app uses Route Resolvers when querying for your Prismic
+     * repository's content, a Link Resolver does not need to be provided.
+     * @see Learn about Link Resolvers and Route Resolvers {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver}
+     */
+    linkResolver?: LinkResolverFunction;
+    /**
+     * A function that maps a Rich Text block to a React component.
+     *
+     * @deprecated Use the `components` prop instead. Prefer using a map
+     *   serializer when possible.
+     * @see Learn about Rich Text serializers {@link https://prismic.io/docs/core-concepts/html-serializer}
+     */
+    htmlSerializer?: JSXFunctionSerializer;
+    /**
+     * A map or function that maps a Rich Text block to a React component.
+     *
+     * @remarks
+     * Prefer using a map serializer over the function serializer when possible.
+     * The map serializer is simpler to maintain.
+     * @example A map serializer.
+     *
+     * ```jsx
+     * {
+     *   heading1: ({children}) => <Heading>{children}</Heading>
+     * }
+     * ```
+     *
+     * @example A function serializer.
+     *
+     * ```jsx
+     * (type, node, content, children) => {
+     * 	switch (type) {
+     * 		case "heading1": {
+     * 			return <Heading>{children}</Heading>;
+     * 		}
+     * 	}
+     * };
+     * ```
+     */
+    components?: JSXMapSerializer | JSXFunctionSerializer;
+    /**
+     * The React component rendered for links when the URL is internal.
+     *
+     * @defaultValue `<a>`
+     */
+    internalLinkComponent?: PrismicLinkProps["internalComponent"];
+    /**
+     * The React component rendered for links when the URL is external.
+     *
+     * @defaultValue `<a>`
+     */
+    externalLinkComponent?: PrismicLinkProps["externalComponent"];
+    /**
+     * The value to be rendered when the field is empty. If a fallback is not
+     * given, `null` will be rendered.
+     */
+    fallback?: React.ReactNode;
+};
+/**
+ * React component that renders content from a Prismic Rich Text field. By
+ * default, HTML elements are rendered for each piece of content. A `heading1`
+ * block will render an `<h1>` HTML element, for example. Links will use
+ * `<PrismicLink>` by default which can be customized using the
+ * `internalLinkComponent` and `externalLinkComponent` props.
+ *
+ * To customize the components that are rendered, provide a map or function
+ * serializer to the `components` prop.
+ *
+ * Components can also be provided in a centralized location using the
+ * `<PrismicProvider>` React context provider.
+ *
+ * @remarks
+ * This component returns a React fragment with no wrapping element around the
+ * content. If you need a wrapper, add a component around `<PrismicRichText>`.
+ * @example Rendering a Rich Text field using the default HTMl elements.
+ *
+ * ```jsx
+ * <PrismicRichText field={document.data.content} />;
+ * ```
+ *
+ * @example Rendering a Rich Text field using a custom set of React components.
+ *
+ * ```jsx
+ * <PrismicRichText
+ * 	field={document.data.content}
+ * 	components={{
+ * 		heading1: ({ children }) => <Heading>{children}</Heading>,
+ * 	}}
+ * />;
+ * ```
+ *
+ * @param props - Props for the component.
+ *
+ * @returns The Rich Text field's content as React components.
+ *
+ * @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
+ * @see Learn about Rich Text serializers {@link https://prismic.io/docs/core-concepts/html-serializer}
+ */
+export declare const PrismicRichText: <LinkResolverFunction extends prismicH.LinkResolverFunction<any> = prismicH.LinkResolverFunction<string>>(props: PrismicRichTextProps<LinkResolverFunction>) => JSX.Element | null;

package/dist/PrismicText.d.ts

@@ -1,39 +1,39 @@
-import * as prismicT from "@prismicio/types";
-/**
- * Props for `<PrismicText>`.
- */
-export type PrismicTextProps = {
-    /**
-     * The Prismic Rich Text field to render.
-     */
-    field: prismicT.RichTextField | null | undefined;
-    /**
-     * The string rendered when the field is empty. If a fallback is not given,
-     * `null` will be rendered.
-     */
-    fallback?: string;
-    /**
-     * The separator used between blocks. Defaults to `\n`.
-     */
-    separator?: string;
-};
-/**
- * React component that renders content from a Prismic Rich Text field as plain
- * text.
- *
- * @remarks
- * This component returns a React fragment with no wrapping element around the
- * content. If you need a wrapper, add a component around `<PrismicText>`.
- * @example Rendering a Rich Text field as plain text.
- *
- * ```jsx
- * <PrismicText field={document.data.content} />;
- * ```
- *
- * @param props - Props for the component.
- *
- * @returns The Rich Text field's content as plain text.
- *
- * @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
- */
-export declare const PrismicText: (props: PrismicTextProps) => JSX.Element | null;
+import * as prismicT from "@prismicio/types";
+/**
+ * Props for `<PrismicText>`.
+ */
+export type PrismicTextProps = {
+    /**
+     * The Prismic Rich Text field to render.
+     */
+    field: prismicT.RichTextField | null | undefined;
+    /**
+     * The string rendered when the field is empty. If a fallback is not given,
+     * `null` will be rendered.
+     */
+    fallback?: string;
+    /**
+     * The separator used between blocks. Defaults to `\n`.
+     */
+    separator?: string;
+};
+/**
+ * React component that renders content from a Prismic Rich Text field as plain
+ * text.
+ *
+ * @remarks
+ * This component returns a React fragment with no wrapping element around the
+ * content. If you need a wrapper, add a component around `<PrismicText>`.
+ * @example Rendering a Rich Text field as plain text.
+ *
+ * ```jsx
+ * <PrismicText field={document.data.content} />;
+ * ```
+ *
+ * @param props - Props for the component.
+ *
+ * @returns The Rich Text field's content as plain text.
+ *
+ * @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
+ */
+export declare const PrismicText: (props: PrismicTextProps) => JSX.Element | null;

package/dist/PrismicToolbar.d.ts

@@ -1,21 +1,21 @@
-/**
- * Props for `<PrismicToolbar>`.
- */
-export type PrismicToolbarProps = {
-    /**
-     * The name of the Prismic repository. For example, `"my-repo"` if the
-     * repository URL is `my-repo.prismic.io`.
-     */
-    repositoryName: string;
-    /**
-     * The type of toolbar needed for the repository. Defaults to `"new"`.
-     *
-     * @see To check which version you need, view the Prismic Toolbar documentation {@link https://prismic.io/docs/technologies/previews-and-the-prismic-toolbar-reactjs}
-     */
-    type?: "new" | "legacy";
-};
-/**
- * React component that injects the Prismic Toolbar into the app. This component
- * can be placed anywhere in the React tree.
- */
-export declare const PrismicToolbar: ({ repositoryName, type, }: PrismicToolbarProps) => null;
+/**
+ * Props for `<PrismicToolbar>`.
+ */
+export type PrismicToolbarProps = {
+    /**
+     * The name of the Prismic repository. For example, `"my-repo"` if the
+     * repository URL is `my-repo.prismic.io`.
+     */
+    repositoryName: string;
+    /**
+     * The type of toolbar needed for the repository. Defaults to `"new"`.
+     *
+     * @see To check which version you need, view the Prismic Toolbar documentation {@link https://prismic.io/docs/technologies/previews-and-the-prismic-toolbar-reactjs}
+     */
+    type?: "new" | "legacy";
+};
+/**
+ * React component that injects the Prismic Toolbar into the app. This component
+ * can be placed anywhere in the React tree.
+ */
+export declare const PrismicToolbar: ({ repositoryName, type, }: PrismicToolbarProps) => null;