@auth-kit/react-router/AuthOutlet.d.ts

React Router Support for React-auth-kit

import * as React from 'react';
/**
 * Component Props for Auth Outlet
 */
interface AuthOutletProps {
    /**
     * Path to redirect if the user is not authenticated
     *
     * @example
     * `/login`
     */
    fallbackPath: string;
}
/**
 * AuthOutlet provides an easy solution to implement private
 * route solutions using the react-router-dom route system
 *
 * @example
 *
 * ```jsx
 * function App() {
 *  return (
 *    <Router>
 *      <Routes>
 *        <Route element={<AuthOutlet fallbackPath='/login' />}>
 *          <Route path='/' element={<Users/>} />
 *          <Route path='/products' element={<Products/>} />
 *        </Route>
 *        <Route path='/login' element={<Login/>}/>
 *      </Routes>
 *    </Router>
 *  );
 * }
 * ```
 */
declare const AuthOutlet: React.FC<AuthOutletProps>;
export default AuthOutlet;