Merge pull request #5458 from marmelab/add-ability-to-disable-redirect-on-logout

Add ability to disable redirection after logout

Author: djhi

docs/Authentication.md

@@ -176,7 +176,7 @@ export default {
 
 The `authProvider` is also a good place to notify the authentication API that the user credentials are no longer valid after logout.
 
-Note that the `authProvider.logout()` method can return the url to which the user will be redirected once logged out. By default, this is the `/login` route.
+Note that after logout, react-admin redirects the user to the string returned by `authProvider.logout()` - or to the `/login` url if the method returns nothing. You can customize the redirection url by returning a route string, or `false` to disable redirection after logout. 
 
 ## Catching Authentication Errors On The API
 

packages/ra-core/src/auth/useLogout.ts

@@ -50,6 +50,10 @@ const useLogout = (): Logout => {
         ) =>
             authProvider.logout(params).then(redirectToFromProvider => {
                 dispatch(clearState());
+                if (redirectToFromProvider === false) {
+                    // do not redirect
+                    return;
+                }
                 // redirectTo can contain a query string, e.g '/login?foo=bar'
                 // we must split the redirectTo to pass a structured location to history.push()
                 const redirectToParts = (

packages/ra-core/src/types.ts

@@ -67,7 +67,7 @@ export interface UserIdentity {
  */
 export type AuthProvider = {
     login: (params: any) => Promise<any>;
-    logout: (params: any) => Promise<void | string>;
+    logout: (params: any) => Promise<void | false | string>;
     checkAuth: (params: any) => Promise<void>;
     checkError: (error: any) => Promise<void>;
     getPermissions: (params: any) => Promise<any>;