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/react-query!home | `tanstack` wrapper around the `displaySharingPage()` action
Parameters
Section titled “Parameters”Optional config object with mutations for customizing the underlying @tanstack/react-query!useMutation | `useMutation()`
mutations?
Section titled “mutations?”MutationOptions
Optional mutation options, see @tanstack/react-query!useMutation | `useMutation()` for more infos
Returns
Section titled “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`
- `displaySharingPage()` for more info about the underlying action
- @tanstack/react-query!useMutation | `useMutation()` for more info about the mutation options and response