Skip to main content
Version: 3.xx.xx

useShow

useShow is an extended version of useOne. It supports all the features of useOne and adds some extra features.

It is useful when you want to fetch a single record from the API. It will return the data and some functions to control the query.

Usage

The useShow hook does not expect any properties. By default, it will try to read the resource and id values from the current URL. It will be passed to the getOne method from the dataProvider as a parameter.

If you define resource and id on the hook, when these properties are changed, the useShow hook will trigger a new request.

http://localhost:3000/products/show/1
import { useShow } from "@pankod/refine-core";

interface IProduct {
id: number;
name: string;
material: string;
}

const ProductShow: React.FC = () => {
const { queryResult } = useShow<IProduct>();

const { data, isLoading, isError } = queryResult;
const product = data?.data;

if (isLoading) {
return <div>Loading...</div>;
}

if (isError) {
return <div>Something went wrong!</div>;
}

return (
<div>
<h3>Product Details</h3>
<p>id: {product?.id}</p>
<p>name: {product?.name}</p>
<p>material: {product?.material}</p>
</div>
);
};

Realtime Updates

This feature is only available if you use a Live Provider.

When the useShow hook is mounted, it will call the subscribe method from the liveProvider with some parameters such as channel, resource etc. It is useful when you want to subscribe to live updates.

Refer to the liveProvider documentation for more information

Properties

resource

Default: It reads the resource value from the current URL.

It will be passed to the getOne method from the dataProvider as parameter via the useOne hook. The parameter is usually used as an API endpoint path. It all depends on how to handle the resource in the getOne method. See the creating a data provider section for an example of how resources are handled.

useShow({
resource: "categories",
});

id

Default: It reads the id value from the current URL.

It will be passed to the getOne method from the dataProvider as a parameter. It is used to determine which record to fetch.

useShow({
id: 123,
});

metaData

metaData is used following two purposes:

  • To pass additional information to data provider methods.
  • Generate GraphQL queries using plain JavaScript Objects (JSON). Please refer GraphQL for more information.

In the following example, we pass the headers property in the metaData object to the create method. With similar logic, you can pass any properties to specifically handle the data provider methods.

useShow({
metaData: {
headers: { "x-meta-data": "true" },
},
});

const myDataProvider = {
//...
getOne: async ({
resource,
id,
metaData,
}) => {
const headers = metaData?.headers ?? {};
const url = `${apiUrl}/${resource}/${id}`;

//...
//...

const { data } = await httpClient.get(`${url}`, { headers });

return {
data,
};
},
//...
};

dataProviderName

If there is more than one dataProvider, you can specify which one to use by passing the dataProviderName prop. It is useful when you have a different data provider for different resources.

useShow({
dataProviderName: "second-data-provider",
});

queryOptions

queryOptions is used to pass additional options to the useQuery hook. It is useful when you want to pass additional options to the useQuery hook.

Refer to the useQuery documentation for more information

useShow({
queryOptions: {
retry: 3,
enabled: false,
},
});

successNotification

NotificationProvider is required for this prop to work.

After data is fetched successfully, useShow can call open function from NotificationProvider to show a success notification. With this prop, you can customize the success notification.

useShow({
successNotification: (data, values, resource) => {
return {
message: `${data.title} Successfully fetched.`,
description: "Success with no errors",
type: "success",
};
},
});

errorNotification

NotificationProvider is required for this prop to work.

After data fetching is failed, useShow will call the open function from NotificationProvider to show an error notification. With this prop, you can customize the error notification.

useShow({
errorNotification: (data, values, resource) => {
return {
message: `Something went wrong when getting ${data.id}`,
description: "Error",
type: "error",
};
},
});

liveMode

LiveProvider is required for this prop to work.

Determines whether to update data automatically ("auto") or not ("manual") if a related live event is received. It can be used to update and show data in Realtime throughout your app. For more information about live mode, please check the Live / Realtime page.

useShow({
liveMode: "auto",
});

onLiveEvent

LiveProvider is required for this prop to work.

The callback function is executed when new events from a subscription have arrived.

useShow({
onLiveEvent: (event) => {
console.log(event);
},
});

liveParams

LiveProvider is required for this prop to work.

Params to pass to liveProvider's subscribe method.

Return Values

queryResult

It is TanStack Query's useQuery return values.

Refer to the useQuery documentation for more information

showId

It is the id value that is used on the useShow hook.

setShowId

When you want to change the showId value, you can use this setter. It is useful when you want to change the showId value based on the user's action.

It will trigger new request to fetch the data when the showId value is changed.

API Reference

Props

Return values

PropertyDescriptionType
queryResultResult of the query of a recordQueryObserverResult<{ data: TData }>
showIdRecord idstring
setShowIdshowId setterDispatch<SetStateAction< string | undefined>>