@prismicio/react 2.5.1 → 2.5.2

package/dist/SliceZone.d.ts

@@ -1,188 +1,188 @@
-import * as React from "react";
-import * as prismicT from "@prismicio/types";
-import { PascalCase } from "./lib/pascalCase";
-/**
- * Returns the type of a `SliceLike` type.
- *
- * @typeParam Slice - The Slice from which the type will be extracted.
- */
-type ExtractSliceType<Slice extends SliceLike> = Slice extends SliceLikeRestV2 ? Slice["slice_type"] : Slice extends SliceLikeGraphQL ? Slice["type"] : never;
-/**
- * The minimum required properties to represent a Prismic Slice from the Prismic
- * Rest API V2 for the `<SliceZone>` component.
- *
- * If using Prismic's Rest API V2, use the `Slice` export from
- * `@prismicio/types` for a full interface.
- *
- * @typeParam SliceType - Type name of the Slice.
- */
-export type SliceLikeRestV2<SliceType extends string = string> = {
-    slice_type: prismicT.Slice<SliceType>["slice_type"];
-    id?: string;
-};
-/**
- * The minimum required properties to represent a Prismic Slice from the Prismic
- * GraphQL API for the `<SliceZone>` component.
- *
- * @typeParam SliceType - Type name of the Slice.
- */
-export type SliceLikeGraphQL<SliceType extends string = string> = {
-    type: prismicT.Slice<SliceType>["slice_type"];
-};
-/**
- * The minimum required properties to represent a Prismic Slice for the
- * `<SliceZone>` component.
- *
- * If using Prismic's Rest API V2, use the `Slice` export from
- * `@prismicio/types` for a full interface.
- *
- * @typeParam SliceType - Type name of the Slice.
- */
-export type SliceLike<SliceType extends string = string> = SliceLikeRestV2<SliceType> | SliceLikeGraphQL<SliceType>;
-/**
- * A looser version of the `SliceZone` type from `@prismicio/types` using
- * `SliceLike`.
- *
- * If using Prismic's Rest API V2, use the `SliceZone` export from
- * `@prismicio/types` for the full type.
- *
- * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
- */
-export type SliceZoneLike<TSlice extends SliceLike = SliceLike> = readonly TSlice[];
-/**
- * React props for a component rendering content from a Prismic Slice using the
- * `<SliceZone>` component.
- *
- * @typeParam TSlice - The Slice passed as a prop.
- * @typeParam TContext - Arbitrary data passed to `<SliceZone>` and made
- *   available to all Slice components.
- */
-export type SliceComponentProps<TSlice extends SliceLike = any, TContext = unknown> = {
-    /**
-     * Slice data for this component.
-     */
-    slice: TSlice;
-    /**
-     * The index of the Slice in the Slice Zone.
-     */
-    index: number;
-    /**
-     * All Slices from the Slice Zone to which the Slice belongs.
-     */
-    slices: SliceZoneLike<SliceLike>;
-    /**
-     * Arbitrary data passed to `<SliceZone>` and made available to all Slice
-     * components.
-     */
-    context: TContext;
-};
-/**
- * A React component to be rendered for each instance of its Slice.
- *
- * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
- * @typeParam TContext - Arbitrary data made available to all Slice components.
- */
-export type SliceComponentType<TSlice extends SliceLike = any, TContext = unknown> = React.ComponentType<SliceComponentProps<TSlice, TContext>>;
-/**
- * A record of Slice types mapped to a React component. The component will be
- * rendered for each instance of its Slice.
- *
- * @deprecated This type is no longer used by `@prismicio/react`. Prefer using
- *   `Record<string, SliceComponentType<any>>` instead.
- * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
- * @typeParam TContext - Arbitrary data made available to all Slice components.
- */
-export type SliceZoneComponents<TSlice extends SliceLike = SliceLike, TContext = unknown> = {
-    [SliceType in ExtractSliceType<TSlice>]: SliceComponentType<Extract<TSlice, SliceLike<SliceType>> extends never ? SliceLike : Extract<TSlice, SliceLike<SliceType>>, TContext>;
-};
-/**
- * This Slice component can be used as a reminder to provide a proper
- * implementation.
- *
- * This is also the default React component rendered when a component mapping
- * cannot be found in `<SliceZone>`.
- */
-export declare const TODOSliceComponent: <TSlice extends SliceLike<string>, TContext>({ slice, }: SliceComponentProps<TSlice, TContext>) => JSX.Element | null;
-/**
- * Arguments for a `<SliceZone>` `resolver` function.
- */
-type SliceZoneResolverArgs<TSlice extends SliceLike = any> = {
-    /**
-     * The Slice to resolve to a React component.
-     */
-    slice: TSlice;
-    /**
-     * The name of the Slice.
-     */
-    sliceName: PascalCase<ExtractSliceType<TSlice>>;
-    /**
-     * The index of the Slice in the Slice Zone.
-     */
-    i: number;
-};
-/**
- * A function that determines the rendered React component for each Slice in the
- * Slice Zone. If a nullish value is returned, the component will fallback to
- * the `components` or `defaultComponent` props to determine the rendered
- * component.
- *
- * @deprecated Use the `components` prop instead.
- *
- * @param args - Arguments for the resolver function.
- *
- * @returns The React component to render for a Slice.
- */
-export type SliceZoneResolver<TSlice extends SliceLike = any, TContext = unknown> = (args: SliceZoneResolverArgs<TSlice>) => SliceComponentType<any, TContext> | undefined | null;
-/**
- * React props for the `<SliceZone>` component.
- *
- * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
- * @typeParam TContext - Arbitrary data made available to all Slice components.
- */
-export type SliceZoneProps<TContext = unknown> = {
-    /**
-     * List of Slice data from the Slice Zone.
-     */
-    slices?: SliceZoneLike;
-    /**
-     * A record mapping Slice types to React components.
-     */
-    components?: Record<string, SliceComponentType<any, TContext>>;
-    /**
-     * A function that determines the rendered React component for each Slice in
-     * the Slice Zone.
-     *
-     * @deprecated Use the `components` prop instead.
-     *
-     * @param args - Arguments for the resolver function.
-     *
-     * @returns The React component to render for a Slice.
-     */
-    resolver?: SliceZoneResolver<any, TContext>;
-    /**
-     * The React component rendered if a component mapping from the `components`
-     * prop cannot be found.
-     */
-    defaultComponent?: SliceComponentType<any, TContext>;
-    /**
-     * Arbitrary data made available to all Slice components.
-     */
-    context?: TContext;
-};
-/**
- * Renders content from a Prismic Slice Zone using React components for each
- * type of Slice.
- *
- * If a component is not provided for a type of Slice, a default component can
- * be provided. A fallback component is provided by default that will not be
- * rendered in a production build of your app.
- *
- * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
- * @typeParam TContext - Arbitrary data made available to all Slice components.
- *
- * @returns The Slice Zone's content as React components.
- *
- * @see Learn about Prismic Slices and Slice Zones {@link https://prismic.io/docs/core-concepts/slices}
- */
-export declare const SliceZone: <TContext>({ slices, components, resolver, defaultComponent, context, }: SliceZoneProps<TContext>) => JSX.Element;
-export {};
+import * as React from "react";
+import * as prismicT from "@prismicio/types";
+import { PascalCase } from "./lib/pascalCase";
+/**
+ * Returns the type of a `SliceLike` type.
+ *
+ * @typeParam Slice - The Slice from which the type will be extracted.
+ */
+type ExtractSliceType<Slice extends SliceLike> = Slice extends SliceLikeRestV2 ? Slice["slice_type"] : Slice extends SliceLikeGraphQL ? Slice["type"] : never;
+/**
+ * The minimum required properties to represent a Prismic Slice from the Prismic
+ * Rest API V2 for the `<SliceZone>` component.
+ *
+ * If using Prismic's Rest API V2, use the `Slice` export from
+ * `@prismicio/types` for a full interface.
+ *
+ * @typeParam SliceType - Type name of the Slice.
+ */
+export type SliceLikeRestV2<SliceType extends string = string> = {
+    slice_type: prismicT.Slice<SliceType>["slice_type"];
+    id?: string;
+};
+/**
+ * The minimum required properties to represent a Prismic Slice from the Prismic
+ * GraphQL API for the `<SliceZone>` component.
+ *
+ * @typeParam SliceType - Type name of the Slice.
+ */
+export type SliceLikeGraphQL<SliceType extends string = string> = {
+    type: prismicT.Slice<SliceType>["slice_type"];
+};
+/**
+ * The minimum required properties to represent a Prismic Slice for the
+ * `<SliceZone>` component.
+ *
+ * If using Prismic's Rest API V2, use the `Slice` export from
+ * `@prismicio/types` for a full interface.
+ *
+ * @typeParam SliceType - Type name of the Slice.
+ */
+export type SliceLike<SliceType extends string = string> = SliceLikeRestV2<SliceType> | SliceLikeGraphQL<SliceType>;
+/**
+ * A looser version of the `SliceZone` type from `@prismicio/types` using
+ * `SliceLike`.
+ *
+ * If using Prismic's Rest API V2, use the `SliceZone` export from
+ * `@prismicio/types` for the full type.
+ *
+ * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
+ */
+export type SliceZoneLike<TSlice extends SliceLike = SliceLike> = readonly TSlice[];
+/**
+ * React props for a component rendering content from a Prismic Slice using the
+ * `<SliceZone>` component.
+ *
+ * @typeParam TSlice - The Slice passed as a prop.
+ * @typeParam TContext - Arbitrary data passed to `<SliceZone>` and made
+ *   available to all Slice components.
+ */
+export type SliceComponentProps<TSlice extends SliceLike = any, TContext = unknown> = {
+    /**
+     * Slice data for this component.
+     */
+    slice: TSlice;
+    /**
+     * The index of the Slice in the Slice Zone.
+     */
+    index: number;
+    /**
+     * All Slices from the Slice Zone to which the Slice belongs.
+     */
+    slices: SliceZoneLike<SliceLike>;
+    /**
+     * Arbitrary data passed to `<SliceZone>` and made available to all Slice
+     * components.
+     */
+    context: TContext;
+};
+/**
+ * A React component to be rendered for each instance of its Slice.
+ *
+ * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
+ * @typeParam TContext - Arbitrary data made available to all Slice components.
+ */
+export type SliceComponentType<TSlice extends SliceLike = any, TContext = unknown> = React.ComponentType<SliceComponentProps<TSlice, TContext>>;
+/**
+ * A record of Slice types mapped to a React component. The component will be
+ * rendered for each instance of its Slice.
+ *
+ * @deprecated This type is no longer used by `@prismicio/react`. Prefer using
+ *   `Record<string, SliceComponentType<any>>` instead.
+ * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
+ * @typeParam TContext - Arbitrary data made available to all Slice components.
+ */
+export type SliceZoneComponents<TSlice extends SliceLike = SliceLike, TContext = unknown> = {
+    [SliceType in ExtractSliceType<TSlice>]: SliceComponentType<Extract<TSlice, SliceLike<SliceType>> extends never ? SliceLike : Extract<TSlice, SliceLike<SliceType>>, TContext>;
+};
+/**
+ * This Slice component can be used as a reminder to provide a proper
+ * implementation.
+ *
+ * This is also the default React component rendered when a component mapping
+ * cannot be found in `<SliceZone>`.
+ */
+export declare const TODOSliceComponent: <TSlice extends SliceLike<string>, TContext>({ slice, }: SliceComponentProps<TSlice, TContext>) => JSX.Element | null;
+/**
+ * Arguments for a `<SliceZone>` `resolver` function.
+ */
+type SliceZoneResolverArgs<TSlice extends SliceLike = any> = {
+    /**
+     * The Slice to resolve to a React component.
+     */
+    slice: TSlice;
+    /**
+     * The name of the Slice.
+     */
+    sliceName: PascalCase<ExtractSliceType<TSlice>>;
+    /**
+     * The index of the Slice in the Slice Zone.
+     */
+    i: number;
+};
+/**
+ * A function that determines the rendered React component for each Slice in the
+ * Slice Zone. If a nullish value is returned, the component will fallback to
+ * the `components` or `defaultComponent` props to determine the rendered
+ * component.
+ *
+ * @deprecated Use the `components` prop instead.
+ *
+ * @param args - Arguments for the resolver function.
+ *
+ * @returns The React component to render for a Slice.
+ */
+export type SliceZoneResolver<TSlice extends SliceLike = any, TContext = unknown> = (args: SliceZoneResolverArgs<TSlice>) => SliceComponentType<any, TContext> | undefined | null;
+/**
+ * React props for the `<SliceZone>` component.
+ *
+ * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
+ * @typeParam TContext - Arbitrary data made available to all Slice components.
+ */
+export type SliceZoneProps<TContext = unknown> = {
+    /**
+     * List of Slice data from the Slice Zone.
+     */
+    slices?: SliceZoneLike;
+    /**
+     * A record mapping Slice types to React components.
+     */
+    components?: Record<string, SliceComponentType<any, TContext>>;
+    /**
+     * A function that determines the rendered React component for each Slice in
+     * the Slice Zone.
+     *
+     * @deprecated Use the `components` prop instead.
+     *
+     * @param args - Arguments for the resolver function.
+     *
+     * @returns The React component to render for a Slice.
+     */
+    resolver?: SliceZoneResolver<any, TContext>;
+    /**
+     * The React component rendered if a component mapping from the `components`
+     * prop cannot be found.
+     */
+    defaultComponent?: SliceComponentType<any, TContext>;
+    /**
+     * Arbitrary data made available to all Slice components.
+     */
+    context?: TContext;
+};
+/**
+ * Renders content from a Prismic Slice Zone using React components for each
+ * type of Slice.
+ *
+ * If a component is not provided for a type of Slice, a default component can
+ * be provided. A fallback component is provided by default that will not be
+ * rendered in a production build of your app.
+ *
+ * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
+ * @typeParam TContext - Arbitrary data made available to all Slice components.
+ *
+ * @returns The Slice Zone's content as React components.
+ *
+ * @see Learn about Prismic Slices and Slice Zones {@link https://prismic.io/docs/core-concepts/slices}
+ */
+export declare const SliceZone: <TContext>({ slices, components, resolver, defaultComponent, context, }: SliceZoneProps<TContext>) => JSX.Element;
+export {};