ra-core/src/auth/useAuthenticated.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { UseQueryOptions } from 'react-query';
import useAuthState from './useAuthState';

/**
 * Restrict access to authenticated users.
 * Redirect anonymous users to the login page.
 *
 * Use it in your custom page components to require
 * authentication.
 *
 * You can set additional `authParams` at will if your authProvider
 * requires it.
 *
 * @example
 *     import { Admin, CustomRoutes, useAuthenticated } from 'react-admin';
 *     const FooPage = () => {
 *         useAuthenticated();
 *         return <Foo />;
 *     }
 *     const customRoutes = [
 *         <Route path="/foo" element={<FooPage />} />
 *     ];
 *     const App = () => (
 *         <Admin>
 *             <CustomRoutes>{customRoutes}</CustomRoutes>
 *         </Admin>
 *     );
 */
export const useAuthenticated = <ParamsType = any>({
    params,
    ...options
}: UseAuthenticatedOptions<ParamsType> = {}) => {
    useAuthState(params ?? emptyParams, true, options);
};

export type UseAuthenticatedOptions<ParamsType> = UseQueryOptions<
    boolean,
    any
> & {
    params?: ParamsType;
};

const emptyParams = {};