ra-core/dist/routing/useRedirect.js

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

import { useCallback } from 'react';
import { useBasename } from "./useBasename.js";
import { useCreatePath } from "./useCreatePath.js";
import { useNavigate } from "./useNavigate.js";
/**
 * Hook for Redirection Side Effect
 *
 * @example
 *
 * const redirect = useRedirect();
 * // redirect to list view
 * redirect('list', 'posts');
 * // redirect to edit view
 * redirect('edit', 'posts', 123);
 * // redirect to edit view with state data
 * redirect('edit', 'comments', 123, {}, { record: { post_id: record.id } });
 * // do not redirect
 * redirect(false);
 * // redirect to the result of a function
 * redirect((resource, id, data) => ...)
 * // redirect to an absolute URL
 * redirect('https://marmelab.com/react-admin');
 */
export const useRedirect = () => {
    const navigate = useNavigate();
    const basename = useBasename();
    const createPath = useCreatePath();
    return useCallback((redirectTo, resource = '', id, data, state = {}) => {
        if (!redirectTo) {
            return;
        }
        else if (typeof redirectTo === 'function') {
            const target = redirectTo(resource, id, data);
            const absoluteTarget = typeof target === 'string'
                ? `${basename}${target.startsWith('/') ? '' : '/'}${target}`
                : {
                    pathname: `${basename}${target.pathname?.startsWith('/') ? '' : '/'}${target.pathname}`,
                    ...target,
                };
            navigate(absoluteTarget, {
                state: { _scrollToTop: true, ...state },
            });
            return;
        }
        else if (typeof redirectTo === 'string' &&
            redirectTo.startsWith('http') &&
            window) {
            // redirection to an absolute url
            // history doesn't handle that case, so we handle it by hand
            window.location.href = redirectTo;
            return;
        }
        else {
            // redirection to an internal link
            navigate(createPath({ resource, id, type: redirectTo }), {
                state: 
                // We force the scrollToTop except when navigating to a list
                // where this is already done by <RestoreScrollPosition> in <Resource>
                redirectTo === 'list'
                    ? state
                    : { _scrollToTop: true, ...state },
            });
            return;
        }
    }, [navigate, basename, createPath]);
};
//# sourceMappingURL=useRedirect.js.map