`useGetOneLive`

This Enterprise EditionReact Admin Enterprise Edition icon hook, alternative to useGetOne, subscribes to live updates on the record.

Usage

import { useRecordContext } from 'react-admin';
import { useGetOneLive } from '@react-admin/ra-realtime';
const UserProfile = () => {
 const record = useRecordContext();
 const { data, isPending, error } = useGetOneLive('users', { id: record.userId });
 if (isPending) {
 return <Loading />;
 }
 if (error) {
 return <p>ERROR</p>;
 }
 return <div>User {data.username}</div>;
};

The hook will subscribe to live updates on the record (topic: resource/[resource]/[id]) and will refetch the record when it is updated or deleted.

See the useGetOne documentation for the full list of parameters and return type.

TypeScript

The useGetOneLive hook accepts a generic parameter for the record type:

import { useRecordContext } from 'react-admin';
import { useGetOneLive } from '@react-admin/ra-realtime';
type Ticket = {
 id: number;
 userId: string;
 message: string;
};
type User = {
 id: number;
 username: string;
}
const UserProfile = () => {
 const ticket = useRecordContext<Ticket>();
 const { data: user, isPending, error } = useGetOneLive<User>('users', { id: ticket.userId });
 if (isPending) { return <Loading />; }
 if (error) { return <p>ERROR</p>; }
 // TypeScript knows that user is of type User
 return <div>User {user.username}</div>;
};