ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
35 lines • 1.2 kB
TypeScript
/**
* Get a callback for calling the authProvider.login() method
* and redirect to the previous authenticated page (or the home page) on success.
*
* @see useAuthProvider
*
* @returns {Function} login callback
*
* @example
*
* import { useLogin } from 'react-admin';
*
* const LoginButton = () => {
* const [loading, setLoading] = useState(false);
* const login = useLogin();
* const handleClick = {
* setLoading(true);
* login({ username: 'john', password: 'p@ssw0rd' }, '/posts')
* .then(() => setLoading(false));
* }
* return <button onClick={handleClick}>Login</button>;
* }
*/
declare const useLogin: () => Login;
/**
* Log a user in by calling the authProvider.login() method
*
* @param {Object} params Login parameters to pass to the authProvider. May contain username/email, password, etc
* @param {string} pathName The path to redirect to after login. By default, redirects to the home page, or to the last page visited after disconnection.
*
* @return {Promise} The authProvider response
*/
type Login = (params: any, pathName?: string) => Promise<any>;
export default useLogin;
//# sourceMappingURL=useLogin.d.ts.map