useOne

The useOne hook expects a resource and id property. It will be passed to the getOne method from the dataProvider as a parameter.

When these properties are changed, the useOne hook will trigger a new request.

import { useState } from "react";
import { useOne, HttpError } from "@pankod/refine-core";

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

const ProductList: React.FC = () => {
    const [id, setId] = useState(1);

    const { data, isLoading, isError } = useOne<IProduct, HttpError>({
        resource: "products",
        id,
    });

    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>

            <br />

            <button
                onClick={() => setId((prev) => prev - 1)}
                disabled={id === 1}
            >
                {"<"} Prev Product
            </button>
            <button onClick={() => setId((prev) => prev + 1)}>
                Next Product {">"}
            </button>
        </div>
    );
};

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

When the useOne 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 →

It will be passed to the getOne method from the dataProvider as a parameter. 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.

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

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

useOne({
  id: 123,
});

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.

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

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 →

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

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.

useOne({
  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,
    };
  },
  //...
};

NotificationProvider is required for this prop to work.

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

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

NotificationProvider is required for this prop to work.

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

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

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.

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

LiveProvider is required for this prop to work.

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

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

LiveProvider is required for this prop to work.

Params to pass to liveProvider's subscribe method.

Returns an object with TanStack Query's useQuery return values.

Refer to the useQuery documentation for more information →