useShow
useShow
is an extended version of useOne
that supports all of its features and adds some more.
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.
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.
For more information, refer to the
liveProvider
documentation→
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",
});
If the resource
is passed, the id
from the current URL will be ignored because it may belong to a different resource. To retrieve the id
value from the current URL, use the useParsed
hook and pass the id
value to the useShow
hook.
import { useShow, useParsed } from "@refinedev/core";
const { id } = useParsed();
useShow({
resource: "custom-resource",
id,
});
Or you can use the setId
function to set the id
value.
import { useShow } from "@refinedev/core";
const { setShowId } = useShow({
resource: "custom-resource",
});
setShowId("123");
If you have multiple resources with the same name, you can pass the identifier
instead of the name
of the resource. It will only be used as the main matching key for the resource, data provider methods will still work with the name
of the resource defined in the <Refine/>
component.
For more information, refer to the
identifier
of the<Refine/>
component documentation →
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,
});
meta
meta
is a special property that can be used to pass additional information to data provider methods for the following purposes:
- Customizing the data provider methods for specific use cases.
- Generating GraphQL queries using plain JavaScript Objects (JSON).
In the following example, we pass the headers
property in the meta
object to the create
method. With similar logic, you can pass any properties to specifically handle the data provider methods.
useShow({
meta: {
headers: { "x-meta-data": "true" },
},
});
const myDataProvider = {
//...
getOne: async ({
resource,
id,
meta,
}) => {
const headers = meta?.headers ?? {};
const url = `${apiUrl}/${resource}/${id}`;
//...
//...
const { data } = await httpClient.get(`${url}`, { headers });
return {
data,
};
},
//...
};
For more information, refer to the
meta
section of the General Concepts documentation →
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.
useShow({
queryOptions: {
retry: 3,
enabled: false,
},
});
For more information, refer to the
useQuery
documentation→
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.
useShow({
liveMode: "auto",
});
For more information, refer to the Live / Realtime page→
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.
overtimeOptions
If you want loading overtime for the request, you can pass the overtimeOptions
prop to the this hook. It is useful when you want to show a loading indicator when the request takes too long.
interval
is the time interval in milliseconds. onInterval
is the function that will be called on each interval.
Return overtime
object from this hook. elapsedTime
is the elapsed time in milliseconds. It becomes undefined
when the request is completed.
const { overtime } = useShow({
//...
overtimeOptions: {
interval: 1000,
onInterval(elapsedInterval) {
console.log(elapsedInterval);
},
}
});
console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...
// You can use it like this:
{elapsedTime >= 4000 && <div>this takes a bit longer than expected</div>}
Return Values
queryResult
It is TanStack Query's useQuery
return values.
For more information, refer to the
useQuery
documentation→
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.
Additional Values
overtime
overtime
object is returned from this hook. elapsedTime
is the elapsed time in milliseconds. It becomes undefined
when the request is completed.
const { overtime } = useShow();
console.log(overtime.elapsedTime); // undefined, 1000, 2000, 3000 4000, ...
API Reference
Props
Type Parameters
Property | Desription | Type | Default |
---|---|---|---|
TQueryFnData | Result data returned by the query function. Extends BaseRecord | BaseRecord | BaseRecord |
TError | Custom error object that extends HttpError | HttpError | HttpError |
TData | Result data returned by the select function. Extends BaseRecord . If not specified, the value of TQueryFnData will be used as the default value. | BaseRecord | TQueryFnData |
Return values
Property | Description | Type |
---|---|---|
queryResult | Result of the query of a record | QueryObserverResult<{ data: TData }> |
showId | Record id | string |
setShowId | showId setter | Dispatch<SetStateAction< string | undefined>> |
overtime | Overtime loading props | { elapsedTime?: number } |