Documentation / @frak-labs/react-sdk / useDisplaySharingPage

useDisplaySharingPage(args?): UseMutationResult<DisplaySharingPageResultType, FrakRpcError<undefined>, DisplaySharingPageParamsType & { placement?: string; }, unknown>

Defined in: react/src/hook/useDisplaySharingPage.ts:45

Hook that return a mutation helping to display a sharing page to the user

It's a `tanstack` wrapper around the `displaySharingPage()` action

Parameters

args?

Optional config object with mutations for customizing the underlying `useMutation()`

mutations?

MutationOptions

Optional mutation options, see `useMutation()` for more infos

Returns

UseMutationResult<DisplaySharingPageResultType, FrakRpcError<undefined>, DisplaySharingPageParamsType & { placement?: string; }, unknown>

The mutation hook wrapping the displaySharingPage() action The mutate and mutateAsync argument is of type `DisplaySharingPageParamsType` with optional placement The data result is a `DisplaySharingPageResultType`

See

• `displaySharingPage()` for more info about the underlying action
• `useMutation()` for more info about the mutation options and response