@prismicio/react 2.0.0-beta.2 → 2.0.0-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +63 -29
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +190 -48
- package/dist/index.mjs +62 -28
- package/dist/index.mjs.map +1 -1
- package/package.json +22 -17
- package/src/PrismicLink.tsx +51 -55
- package/src/PrismicProvider.tsx +8 -7
- package/src/PrismicRichText.tsx +13 -12
- package/src/PrismicText.tsx +2 -1
- package/src/SliceZone.tsx +68 -1
- package/src/{hooks.ts → clientHooks.ts} +78 -24
- package/src/index.ts +6 -2
- package/src/usePrismicClient.ts +1 -1
- package/src/usePrismicPreviewResolver.ts +88 -0
- package/src/useStatefulPrismicClientMethod.ts +45 -21
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
+
import * as _prismicio_client from '@prismicio/client';
|
|
1
2
|
import * as React from 'react';
|
|
2
|
-
import * as prismic from '@prismicio/client';
|
|
3
3
|
import * as prismicH from '@prismicio/helpers';
|
|
4
4
|
import * as prismicT from '@prismicio/types';
|
|
5
5
|
import * as prismicR from '@prismicio/richtext';
|
|
@@ -31,7 +31,7 @@ interface LinkProps {
|
|
|
31
31
|
/**
|
|
32
32
|
* Props for `<PrismicLink>`.
|
|
33
33
|
*/
|
|
34
|
-
declare type PrismicLinkProps<InternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, ExternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, LinkResolverFunction extends prismicH.LinkResolverFunction
|
|
34
|
+
declare type PrismicLinkProps<InternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, ExternalComponent extends string | React.ComponentType<LinkProps> = string | React.ComponentType<LinkProps>, LinkResolverFunction extends prismicH.LinkResolverFunction = prismicH.LinkResolverFunction> = Omit<ComponentProps<InternalComponent> & ComponentProps<ExternalComponent>, keyof LinkProps> & {
|
|
35
35
|
/**
|
|
36
36
|
* The Link Resolver used to resolve links.
|
|
37
37
|
*
|
|
@@ -72,17 +72,17 @@ declare type PrismicLinkProps<InternalComponent extends string | React.Component
|
|
|
72
72
|
*
|
|
73
73
|
* @see Learn about Prismic Link fields {@link https://prismic.io/docs/core-concepts/link-content-relationship}
|
|
74
74
|
*/
|
|
75
|
-
field
|
|
75
|
+
field: prismicT.LinkField | null | undefined;
|
|
76
76
|
} | {
|
|
77
77
|
/**
|
|
78
78
|
* The Prismic document to link.
|
|
79
79
|
*/
|
|
80
|
-
document
|
|
80
|
+
document: prismicT.PrismicDocument | null | undefined;
|
|
81
81
|
} | {
|
|
82
82
|
/**
|
|
83
83
|
* The URL to link.
|
|
84
84
|
*/
|
|
85
|
-
href
|
|
85
|
+
href: string | null | undefined;
|
|
86
86
|
});
|
|
87
87
|
/**
|
|
88
88
|
* React component that renders a link from a Prismic Link field.
|
|
@@ -99,7 +99,7 @@ declare type PrismicLinkProps<InternalComponent extends string | React.Component
|
|
|
99
99
|
* @returns The internal or external link component depending on whether the
|
|
100
100
|
* link is internal or external.
|
|
101
101
|
*/
|
|
102
|
-
declare const PrismicLink: <InternalComponent extends string | React.ComponentType<LinkProps
|
|
102
|
+
declare const PrismicLink: <InternalComponent extends string | React.ComponentType<LinkProps>, ExternalComponent extends string | React.ComponentType<LinkProps>, LinkResolverFunction extends prismicH.LinkResolverFunction<string>>(props: PrismicLinkProps<InternalComponent, ExternalComponent, LinkResolverFunction>) => JSX.Element | null;
|
|
103
103
|
|
|
104
104
|
/**
|
|
105
105
|
* A function mapping Rich Text block types to React Components. It is used to
|
|
@@ -130,7 +130,7 @@ declare type PrismicContextValue = {
|
|
|
130
130
|
* repository. This is used by `@prismicio/react` hooks, such as
|
|
131
131
|
* `usePrismicDocuments()`.
|
|
132
132
|
*/
|
|
133
|
-
client?:
|
|
133
|
+
client?: _prismicio_client.Client;
|
|
134
134
|
/**
|
|
135
135
|
* A Link Resolver used to resolve links for `<PrismicLink>` and `<PrismicRichText>`.
|
|
136
136
|
*
|
|
@@ -158,12 +158,12 @@ declare type PrismicContextValue = {
|
|
|
158
158
|
*
|
|
159
159
|
* ```jsx
|
|
160
160
|
* (type, node, content, children) => {
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
*
|
|
166
|
-
* }
|
|
161
|
+
* switch (type) {
|
|
162
|
+
* case "heading1": {
|
|
163
|
+
* return <Heading>{chidlren}</Heading>;
|
|
164
|
+
* }
|
|
165
|
+
* }
|
|
166
|
+
* };
|
|
167
167
|
* ```
|
|
168
168
|
*/
|
|
169
169
|
richTextComponents?: JSXMapSerializer | JSXFunctionSerializer;
|
|
@@ -209,7 +209,7 @@ declare const usePrismicContext: () => PrismicContextValue;
|
|
|
209
209
|
*
|
|
210
210
|
* @returns The `@prismicio/client` instance provided to `<PrismicProvider>`.
|
|
211
211
|
*/
|
|
212
|
-
declare const usePrismicClient: (explicitClient?:
|
|
212
|
+
declare const usePrismicClient: (explicitClient?: _prismicio_client.Client | undefined) => _prismicio_client.Client;
|
|
213
213
|
|
|
214
214
|
/**
|
|
215
215
|
* Props for `<PrismicText>`.
|
|
@@ -233,12 +233,13 @@ declare type PrismicTextProps = {
|
|
|
233
233
|
* @example Rendering a Rich Text field as plain text.
|
|
234
234
|
*
|
|
235
235
|
* ```jsx
|
|
236
|
-
* <PrismicText field={document.data.content}
|
|
236
|
+
* <PrismicText field={document.data.content} />;
|
|
237
237
|
* ```
|
|
238
238
|
*
|
|
239
239
|
* @param props - Props for the component.
|
|
240
240
|
*
|
|
241
241
|
* @returns The Rich Text field's content as plain text.
|
|
242
|
+
*
|
|
242
243
|
* @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
|
|
243
244
|
*/
|
|
244
245
|
declare const PrismicText: (props: PrismicTextProps) => JSX.Element | null;
|
|
@@ -286,12 +287,12 @@ declare type PrismicRichTextProps = {
|
|
|
286
287
|
*
|
|
287
288
|
* ```jsx
|
|
288
289
|
* (type, node, content, children) => {
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
* }
|
|
290
|
+
* switch (type) {
|
|
291
|
+
* case "heading1": {
|
|
292
|
+
* return <Heading>{chidlren}</Heading>;
|
|
293
|
+
* }
|
|
294
|
+
* }
|
|
295
|
+
* };
|
|
295
296
|
* ```
|
|
296
297
|
*/
|
|
297
298
|
components?: JSXMapSerializer | JSXFunctionSerializer;
|
|
@@ -327,23 +328,24 @@ declare type PrismicRichTextProps = {
|
|
|
327
328
|
* @example Rendering a Rich Text field using the default HTMl elements.
|
|
328
329
|
*
|
|
329
330
|
* ```jsx
|
|
330
|
-
* <PrismicRichText field={document.data.content}
|
|
331
|
+
* <PrismicRichText field={document.data.content} />;
|
|
331
332
|
* ```
|
|
332
333
|
*
|
|
333
334
|
* @example Rendering a Rich Text field using a custom set of React components.
|
|
334
335
|
*
|
|
335
336
|
* ```jsx
|
|
336
337
|
* <PrismicRichText
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
338
|
+
* field={document.data.content}
|
|
339
|
+
* components={{
|
|
340
|
+
* heading1: ({ children }) => <Heading>{children}</Heading>,
|
|
341
|
+
* }}
|
|
342
|
+
* />;
|
|
342
343
|
* ```
|
|
343
344
|
*
|
|
344
345
|
* @param props - Props for the component.
|
|
345
346
|
*
|
|
346
347
|
* @returns The Rich Text field's content as React components.
|
|
348
|
+
*
|
|
347
349
|
* @see Learn about Rich Text fields {@link https://prismic.io/docs/core-concepts/rich-text-title}
|
|
348
350
|
* @see Learn about Rich Text serializers {@link https://prismic.io/docs/core-concepts/html-serializer}
|
|
349
351
|
*/
|
|
@@ -418,6 +420,35 @@ declare type SliceZoneComponents<TSlice extends SliceLike = SliceLike, TContext
|
|
|
418
420
|
* cannot be found in `<SliceZone>`.
|
|
419
421
|
*/
|
|
420
422
|
declare const TODOSliceComponent: <TSlice extends SliceLike<string>, TContext>({ slice, }: SliceComponentProps<TSlice, TContext>) => JSX.Element | null;
|
|
423
|
+
/**
|
|
424
|
+
* Arguments for a `<SliceZone>` `resolver` function.
|
|
425
|
+
*/
|
|
426
|
+
declare type SliceZoneResolverArgs<TSlice extends SliceLike = SliceLike> = {
|
|
427
|
+
/**
|
|
428
|
+
* The Slice to resolve to a React component.
|
|
429
|
+
*/
|
|
430
|
+
slice: TSlice;
|
|
431
|
+
/**
|
|
432
|
+
* The name of the Slice.
|
|
433
|
+
*/
|
|
434
|
+
sliceName: TSlice["slice_type"];
|
|
435
|
+
/**
|
|
436
|
+
* The index of the Slice in the Slice Zone.
|
|
437
|
+
*/
|
|
438
|
+
i: number;
|
|
439
|
+
};
|
|
440
|
+
/**
|
|
441
|
+
* A function that determines the rendered React component for each Slice in the
|
|
442
|
+
* Slice Zone. If a nullish value is returned, the component will fallback to
|
|
443
|
+
* the `components` or `defaultComponent` props to determine the rendered component.
|
|
444
|
+
*
|
|
445
|
+
* @deprecated Use the `components` prop instead.
|
|
446
|
+
*
|
|
447
|
+
* @param args - Arguments for the resolver function.
|
|
448
|
+
*
|
|
449
|
+
* @returns The React component to render for a Slice.
|
|
450
|
+
*/
|
|
451
|
+
declare type SliceZoneResolver<TSlice extends SliceLike = SliceLike, TContext = unknown> = (args: SliceZoneResolverArgs<TSlice>) => SliceComponentType<TSlice, TContext> | undefined | null;
|
|
421
452
|
/**
|
|
422
453
|
* React props for the `<SliceZone>` component.
|
|
423
454
|
*
|
|
@@ -433,6 +464,17 @@ declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unk
|
|
|
433
464
|
* A record mapping Slice types to React components.
|
|
434
465
|
*/
|
|
435
466
|
components?: SliceZoneComponents<TSlice, TContext>;
|
|
467
|
+
/**
|
|
468
|
+
* A function that determines the rendered React component for each Slice in
|
|
469
|
+
* the Slice Zone.
|
|
470
|
+
*
|
|
471
|
+
* @deprecated Use the `components` prop instead.
|
|
472
|
+
*
|
|
473
|
+
* @param args - Arguments for the resolver function.
|
|
474
|
+
*
|
|
475
|
+
* @returns The React component to render for a Slice.
|
|
476
|
+
*/
|
|
477
|
+
resolver?: SliceZoneResolver<TSlice, TContext>;
|
|
436
478
|
/**
|
|
437
479
|
* The React component rendered if a component mapping from the `components`
|
|
438
480
|
* prop cannot be found.
|
|
@@ -453,10 +495,12 @@ declare type SliceZoneProps<TSlice extends SliceLike = SliceLike, TContext = unk
|
|
|
453
495
|
*
|
|
454
496
|
* @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
|
|
455
497
|
* @typeParam TContext - Arbitrary data made available to all Slice components.
|
|
498
|
+
*
|
|
456
499
|
* @returns The Slice Zone's content as React components.
|
|
500
|
+
*
|
|
457
501
|
* @see Learn about Prismic Slices and Slice Zones {@link https://prismic.io/docs/core-concepts/slices}
|
|
458
502
|
*/
|
|
459
|
-
declare const SliceZone: <TSlice extends SliceLike<string>, TContext>({ slices, components, defaultComponent, context, }: SliceZoneProps<TSlice, TContext>) => JSX.Element;
|
|
503
|
+
declare const SliceZone: <TSlice extends SliceLike<string>, TContext>({ slices, components, resolver, defaultComponent, context, }: SliceZoneProps<TSlice, TContext>) => JSX.Element;
|
|
460
504
|
|
|
461
505
|
/**
|
|
462
506
|
* Props for `<PrismicToolbar>`.
|
|
@@ -486,7 +530,7 @@ declare type StateMachineState<TData> = {
|
|
|
486
530
|
error?: Error;
|
|
487
531
|
};
|
|
488
532
|
declare type HookOnlyParameters = {
|
|
489
|
-
client?:
|
|
533
|
+
client?: _prismicio_client.Client;
|
|
490
534
|
skip?: boolean;
|
|
491
535
|
};
|
|
492
536
|
/**
|
|
@@ -505,44 +549,97 @@ declare type ClientHookReturnType<TData = unknown> = [
|
|
|
505
549
|
state: Pick<StateMachineState<TData>, "state" | "error">
|
|
506
550
|
];
|
|
507
551
|
|
|
552
|
+
declare type UsePrismicPreviewResolverArgs = {
|
|
553
|
+
/**
|
|
554
|
+
* An optional `@prismicio/client` instance to override the Client provided to
|
|
555
|
+
* `<PrismicProvider>`
|
|
556
|
+
*/
|
|
557
|
+
client?: _prismicio_client.Client;
|
|
558
|
+
/**
|
|
559
|
+
* A function that maps a Prismic document to a URL within your app.
|
|
560
|
+
*/
|
|
561
|
+
linkResolver?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["linkResolver"];
|
|
562
|
+
/**
|
|
563
|
+
* A fallback URL if the Link Resolver does not return a value.
|
|
564
|
+
*/
|
|
565
|
+
defaultURL?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["defaultURL"];
|
|
566
|
+
/**
|
|
567
|
+
* The preview token (also known as a ref) that will be used to query preview
|
|
568
|
+
* content from the Prismic repository.
|
|
569
|
+
*/
|
|
570
|
+
previewToken?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["previewToken"];
|
|
571
|
+
/**
|
|
572
|
+
* The previewed document that will be used to determine the destination URL.
|
|
573
|
+
*/
|
|
574
|
+
documentID?: Parameters<_prismicio_client.Client["resolvePreviewURL"]>[0]["documentID"];
|
|
575
|
+
/**
|
|
576
|
+
* A function to automatically navigate to the resolved URL. If a function is
|
|
577
|
+
* not provded, `usePreviewResolver` will not navigate to the URL.
|
|
578
|
+
*
|
|
579
|
+
* @param url - The resolved preview URL.
|
|
580
|
+
*/
|
|
581
|
+
navigate?: (url: string) => unknown;
|
|
582
|
+
};
|
|
583
|
+
/**
|
|
584
|
+
* Resolve a preview session's URL. The resolved URL can be used to redirect to
|
|
585
|
+
* the previewed document.
|
|
586
|
+
*
|
|
587
|
+
* If a `navigate` function is provided, the hook will automatically navigate to
|
|
588
|
+
* the previewed document's URL.
|
|
589
|
+
*
|
|
590
|
+
* @param args - Arguments to configure how a URL is resolved.
|
|
591
|
+
*
|
|
592
|
+
* @returns A tuple containing the resolved URL and the hook's state.
|
|
593
|
+
*/
|
|
594
|
+
declare const usePrismicPreviewResolver: (args?: UsePrismicPreviewResolverArgs) => ClientHookReturnType<string>;
|
|
595
|
+
|
|
508
596
|
/**
|
|
509
597
|
* A hook that queries content from the Prismic repository.
|
|
510
598
|
*
|
|
511
599
|
* @remarks
|
|
512
600
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
601
|
+
*
|
|
513
602
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
603
|
+
*
|
|
514
604
|
* @param params - Parameters to filter, sort, and paginate results
|
|
515
605
|
*
|
|
516
606
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
607
|
+
*
|
|
517
608
|
* @see Underlying `@prismicio/client` method {@link proto.get}
|
|
518
609
|
*/
|
|
519
|
-
declare const usePrismicDocuments: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<
|
|
610
|
+
declare const usePrismicDocuments: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
|
|
520
611
|
/**
|
|
521
612
|
* A hook that queries content from the Prismic repository and returns only the
|
|
522
613
|
* first result, if any.
|
|
523
614
|
*
|
|
524
615
|
* @remarks
|
|
525
616
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
617
|
+
*
|
|
526
618
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
619
|
+
*
|
|
527
620
|
* @param params - Parameters to filter, sort, and paginate results
|
|
528
621
|
*
|
|
529
622
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
623
|
+
*
|
|
530
624
|
* @see Underlying `@prismicio/client` method {@link proto.getFirst}
|
|
531
625
|
*/
|
|
532
|
-
declare const useFirstPrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<
|
|
626
|
+
declare const useFirstPrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
|
|
533
627
|
/**
|
|
534
628
|
* A hook that queries content from the Prismic repository and returns all
|
|
535
629
|
* matching content. If no predicates are provided, all documents will be fetched.
|
|
536
630
|
*
|
|
537
631
|
* @remarks
|
|
538
632
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
633
|
+
*
|
|
539
634
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
635
|
+
*
|
|
540
636
|
* @param params - Parameters to filter and sort results
|
|
541
637
|
*
|
|
542
638
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
639
|
+
*
|
|
543
640
|
* @see Underlying `@prismicio/client` method {@link proto.getAll}
|
|
544
641
|
*/
|
|
545
|
-
declare const
|
|
642
|
+
declare const useAllPrismicDocumentsDangerously: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & {
|
|
546
643
|
limit?: number | undefined;
|
|
547
644
|
} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
|
|
548
645
|
/**
|
|
@@ -550,207 +647,252 @@ declare const useAllPrismicDocuments: <TDocument extends prismicT.PrismicDocumen
|
|
|
550
647
|
*
|
|
551
648
|
* @remarks
|
|
552
649
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
650
|
+
*
|
|
553
651
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
652
|
+
*
|
|
554
653
|
* @param id - ID of the document
|
|
555
654
|
* @param params - Parameters to filter, sort, and paginate results
|
|
556
655
|
*
|
|
557
656
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
657
|
+
*
|
|
558
658
|
* @see Underlying `@prismicio/client` method {@link proto.getByID}
|
|
559
659
|
*/
|
|
560
|
-
declare const usePrismicDocumentByID: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string, params?: (Partial<
|
|
660
|
+
declare const usePrismicDocumentByID: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
|
|
561
661
|
/**
|
|
562
662
|
* A hook that queries documents from the Prismic repository with specific IDs.
|
|
563
663
|
*
|
|
564
664
|
* @remarks
|
|
565
665
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
666
|
+
*
|
|
566
667
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
668
|
+
*
|
|
567
669
|
* @param ids - A list of document IDs
|
|
568
670
|
* @param params - Parameters to filter, sort, and paginate results
|
|
569
671
|
*
|
|
570
672
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
673
|
+
*
|
|
571
674
|
* @see Underlying `@prismicio/client` method {@link proto.getByIDs}
|
|
572
675
|
*/
|
|
573
|
-
declare const usePrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string[], params?: (Partial<
|
|
676
|
+
declare const usePrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
|
|
574
677
|
/**
|
|
575
678
|
* A hook that queries all documents from the Prismic repository with specific IDs.
|
|
576
679
|
*
|
|
577
680
|
* @remarks
|
|
578
681
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
682
|
+
*
|
|
579
683
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
684
|
+
*
|
|
580
685
|
* @param ids - A list of document IDs
|
|
581
686
|
* @param params - Parameters to filter and sort results
|
|
582
687
|
*
|
|
583
688
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
689
|
+
*
|
|
584
690
|
* @see Underlying `@prismicio/client` method {@link proto.getAllByIDs}
|
|
585
691
|
*/
|
|
586
|
-
declare const useAllPrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string[], params?: (Partial<
|
|
692
|
+
declare const useAllPrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(id: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
|
|
587
693
|
/**
|
|
588
694
|
* A hook that queries a document from the Prismic repository with a specific
|
|
589
695
|
* UID and Custom Type.
|
|
590
696
|
*
|
|
591
697
|
* @remarks
|
|
592
698
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
699
|
+
*
|
|
593
700
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
701
|
+
*
|
|
594
702
|
* @param documentType - The API ID of the document's Custom Type
|
|
595
703
|
* @param uid - UID of the document
|
|
596
704
|
* @param params - Parameters to filter, sort, and paginate results
|
|
597
705
|
*
|
|
598
706
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
707
|
+
*
|
|
599
708
|
* @see Underlying `@prismicio/client` method {@link proto.getByUID}
|
|
600
709
|
*/
|
|
601
|
-
declare const usePrismicDocumentByUID: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uid: string, params?: (Partial<
|
|
710
|
+
declare const usePrismicDocumentByUID: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uid: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
|
|
602
711
|
/**
|
|
603
712
|
* A hook that queries documents from the Prismic repository with specific UIDs
|
|
604
713
|
* of a Custom Type.
|
|
605
714
|
*
|
|
606
715
|
* @remarks
|
|
607
716
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
717
|
+
*
|
|
608
718
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
719
|
+
*
|
|
609
720
|
* @param documentType - The API ID of the document's Custom Type
|
|
610
721
|
* @param uids - A list of document UIDs.
|
|
611
722
|
* @param params - Parameters to filter, sort, and paginate results
|
|
612
723
|
*
|
|
613
724
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
725
|
+
*
|
|
614
726
|
* @see Underlying `@prismicio/client` method {@link proto.getByUID}
|
|
615
727
|
*/
|
|
616
|
-
declare const usePrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uids: string[], params?: (Partial<
|
|
728
|
+
declare const usePrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
|
|
617
729
|
/**
|
|
618
730
|
* A hook that queries all documents from the Prismic repository with specific
|
|
619
731
|
* UIDs of a Custom Type.
|
|
620
732
|
*
|
|
621
733
|
* @remarks
|
|
622
734
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
735
|
+
*
|
|
623
736
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
737
|
+
*
|
|
624
738
|
* @param documentType - The API ID of the document's Custom Type
|
|
625
739
|
* @param uids - A list of document UIDs.
|
|
626
740
|
* @param params - Parameters to filter, sort, and paginate results
|
|
627
741
|
*
|
|
628
742
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
743
|
+
*
|
|
629
744
|
* @see Underlying `@prismicio/client` method {@link proto.getByUID}
|
|
630
745
|
*/
|
|
631
|
-
declare const useAllPrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uids: string[], params?: (Partial<
|
|
746
|
+
declare const useAllPrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, uids: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
|
|
632
747
|
/**
|
|
633
748
|
* A hook that queries a singleton document from the Prismic repository for a
|
|
634
749
|
* specific Custom Type.
|
|
635
750
|
*
|
|
636
751
|
* @remarks
|
|
637
752
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
753
|
+
*
|
|
638
754
|
* @typeParam TDocument - Type of the Prismic document returned
|
|
755
|
+
*
|
|
639
756
|
* @param documentType - The API ID of the singleton Custom Type
|
|
640
757
|
* @param params - Parameters to filter, sort, and paginate results
|
|
641
758
|
*
|
|
642
759
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
760
|
+
*
|
|
643
761
|
* @see Underlying `@prismicio/client` method {@link proto.getSingle}
|
|
644
762
|
*/
|
|
645
|
-
declare const useSinglePrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<
|
|
763
|
+
declare const useSinglePrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
|
|
646
764
|
/**
|
|
647
765
|
* A hook that queries documents from the Prismic repository for a specific Custom Type.
|
|
648
766
|
*
|
|
649
767
|
* @remarks
|
|
650
768
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
769
|
+
*
|
|
651
770
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
771
|
+
*
|
|
652
772
|
* @param documentType - The API ID of the Custom Type
|
|
653
773
|
* @param params - Parameters to filter, sort, and paginate results
|
|
654
774
|
*
|
|
655
775
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
776
|
+
*
|
|
656
777
|
* @see Underlying `@prismicio/client` method {@link proto.getByType}
|
|
657
778
|
*/
|
|
658
|
-
declare const usePrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<
|
|
779
|
+
declare const usePrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
|
|
659
780
|
/**
|
|
660
781
|
* A hook that queries all documents from the Prismic repository for a specific
|
|
661
782
|
* Custom Type.
|
|
662
783
|
*
|
|
663
784
|
* @remarks
|
|
664
785
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
786
|
+
*
|
|
665
787
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
788
|
+
*
|
|
666
789
|
* @param documentType - The API ID of the Custom Type
|
|
667
790
|
* @param params - Parameters to filter and sort results
|
|
668
791
|
*
|
|
669
792
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
793
|
+
*
|
|
670
794
|
* @see Underlying `@prismicio/client` method {@link proto.getAllByType}
|
|
671
795
|
*/
|
|
672
|
-
declare const useAllPrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<Omit<
|
|
796
|
+
declare const useAllPrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(documentType: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
|
|
673
797
|
/**
|
|
674
798
|
* A hook that queries documents from the Prismic repository with a specific tag.
|
|
675
799
|
*
|
|
676
800
|
* @remarks
|
|
677
801
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
802
|
+
*
|
|
678
803
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
804
|
+
*
|
|
679
805
|
* @param tag - The tag that must be included on a document
|
|
680
806
|
* @param params - Parameters to filter, sort, and paginate results
|
|
681
807
|
*
|
|
682
808
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
809
|
+
*
|
|
683
810
|
* @see Underlying `@prismicio/client` method {@link proto.getByTag}
|
|
684
811
|
*/
|
|
685
|
-
declare const usePrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<
|
|
812
|
+
declare const usePrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
|
|
686
813
|
/**
|
|
687
814
|
* A hook that queries all documents from the Prismic repository with a specific tag.
|
|
688
815
|
*
|
|
689
816
|
* @remarks
|
|
690
817
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
818
|
+
*
|
|
691
819
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
820
|
+
*
|
|
692
821
|
* @param tag - The tag that must be included on a document
|
|
693
822
|
* @param params - Parameters to filter and sort results
|
|
694
823
|
*
|
|
695
824
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
825
|
+
*
|
|
696
826
|
* @see Underlying `@prismicio/client` method {@link proto.getAllByTag}
|
|
697
827
|
*/
|
|
698
|
-
declare const useAllPrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<Omit<
|
|
828
|
+
declare const useAllPrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string, params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
|
|
699
829
|
/**
|
|
700
830
|
* A hook that queries documents from the Prismic repository with specific tags.
|
|
701
831
|
* A document must be tagged with at least one of the queried tags to be included.
|
|
702
832
|
*
|
|
703
833
|
* @remarks
|
|
704
834
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
835
|
+
*
|
|
705
836
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
837
|
+
*
|
|
706
838
|
* @param tags - A list of tags that must be included on a document
|
|
707
839
|
* @param params - Parameters to filter, sort, and paginate results
|
|
708
840
|
*
|
|
709
841
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
842
|
+
*
|
|
710
843
|
* @see Underlying `@prismicio/client` method {@link proto.getByTags}
|
|
711
844
|
*/
|
|
712
|
-
declare const usePrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<
|
|
845
|
+
declare const usePrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
|
|
713
846
|
/**
|
|
714
847
|
* A hook that queries all documents from the Prismic repository with specific
|
|
715
848
|
* tags. A document must be tagged with at least one of the queried tags to be included.
|
|
716
849
|
*
|
|
717
850
|
* @remarks
|
|
718
851
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
852
|
+
*
|
|
719
853
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
854
|
+
*
|
|
720
855
|
* @param tags - A list of tags that must be included on a document
|
|
721
856
|
* @param params - Parameters to filter and sort results
|
|
722
857
|
*
|
|
723
858
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
859
|
+
*
|
|
724
860
|
* @see Underlying `@prismicio/client` method {@link proto.getAllByTags}
|
|
725
861
|
*/
|
|
726
|
-
declare const useAllPrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<Omit<
|
|
862
|
+
declare const useAllPrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
|
|
727
863
|
/**
|
|
728
864
|
* A hook that queries documents from the Prismic repository with specific tags.
|
|
729
865
|
* A document must be tagged with all of the queried tags to be included.
|
|
730
866
|
*
|
|
731
867
|
* @remarks
|
|
732
868
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
869
|
+
*
|
|
733
870
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
871
|
+
*
|
|
734
872
|
* @param tags - A list of tags that must be included on a document
|
|
735
873
|
* @param params - Parameters to filter, sort, and paginate results
|
|
736
874
|
*
|
|
737
875
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
876
|
+
*
|
|
738
877
|
* @see Underlying `@prismicio/client` method {@link proto.getByTags}
|
|
739
878
|
*/
|
|
740
|
-
declare const usePrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<
|
|
879
|
+
declare const usePrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<_prismicio_client.BuildQueryURLArgs> & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
|
|
741
880
|
/**
|
|
742
881
|
* A hook that queries all documents from the Prismic repository with specific
|
|
743
882
|
* tags. A document must be tagged with all of the queried tags to be included.
|
|
744
883
|
*
|
|
745
884
|
* @remarks
|
|
746
885
|
* An additional `@prismicio/client` instance can be provided at `params.client`.
|
|
886
|
+
*
|
|
747
887
|
* @typeParam TDocument - Type of Prismic documents returned
|
|
888
|
+
*
|
|
748
889
|
* @param tags - A list of tags that must be included on a document
|
|
749
890
|
* @param params - Parameters to filter and sort results
|
|
750
891
|
*
|
|
751
892
|
* @returns The composable payload {@link ClientHookReturnType}
|
|
893
|
+
*
|
|
752
894
|
* @see Underlying `@prismicio/client` method {@link proto.getAllByTags}
|
|
753
895
|
*/
|
|
754
|
-
declare const useAllPrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<Omit<
|
|
896
|
+
declare const useAllPrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, prismicT.AnyRegularField | prismicT.GroupField<Record<string, prismicT.AnyRegularField>> | prismicT.SliceZone<prismicT.Slice<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>> | prismicT.SharedSlice<string, prismicT.SharedSliceVariation<string, Record<string, prismicT.AnyRegularField>, Record<string, prismicT.AnyRegularField>>>>>, string, string>>(tag: string[], params?: (Partial<Omit<_prismicio_client.BuildQueryURLArgs, "page">> & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
|
|
755
897
|
|
|
756
|
-
export { JSXFunctionSerializer, JSXMapSerializer, LinkProps, PrismicClientHookState, PrismicContextValue, PrismicLink, PrismicLinkProps, PrismicProvider, PrismicProviderProps, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, PrismicToolbar, PrismicToolbarProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneLike, SliceZoneProps, TODOSliceComponent,
|
|
898
|
+
export { JSXFunctionSerializer, JSXMapSerializer, LinkProps, PrismicClientHookState, PrismicContextValue, PrismicLink, PrismicLinkProps, PrismicProvider, PrismicProviderProps, PrismicRichText, PrismicRichTextProps, PrismicText, PrismicTextProps, PrismicToolbar, PrismicToolbarProps, SliceComponentProps, SliceComponentType, SliceLike, SliceZone, SliceZoneComponents, SliceZoneLike, SliceZoneProps, SliceZoneResolver, TODOSliceComponent, UsePrismicPreviewResolverArgs, useAllPrismicDocumentsByEveryTag, useAllPrismicDocumentsByIDs, useAllPrismicDocumentsBySomeTags, useAllPrismicDocumentsByTag, useAllPrismicDocumentsByType, useAllPrismicDocumentsByUIDs, useAllPrismicDocumentsDangerously, useFirstPrismicDocument, usePrismicClient, usePrismicContext, usePrismicDocumentByID, usePrismicDocumentByUID, usePrismicDocuments, usePrismicDocumentsByEveryTag, usePrismicDocumentsByIDs, usePrismicDocumentsBySomeTags, usePrismicDocumentsByTag, usePrismicDocumentsByType, usePrismicDocumentsByUIDs, usePrismicPreviewResolver, useSinglePrismicDocument };
|