import { useContext } from "react";

import { RefineContext } from "@contexts/refine";
import { UnsavedWarnContext } from "@contexts/unsavedWarn";
import { IRefineContext, IUnsavedWarnContext } from "../../../interfaces";

type UseWarnAboutChangeType = () => {
    warnWhenUnsavedChanges: IRefineContext["warnWhenUnsavedChanges"];
    warnWhen: IUnsavedWarnContext["warnWhen"];
    setWarnWhen: IUnsavedWarnContext["setWarnWhen"];
};

/**
 * When you have unsaved changes and try to leave the current page, **refine** shows a confirmation modal box.
 * To activate this feature, set the `warnWhenUnsavedChanges` to `true`.
 *
 * @see {@link https://refine.dev/docs/api-references/components/refine-config#warnwhenunsavedchanges} for more details.
 */
export const useWarnAboutChange: UseWarnAboutChangeType = () => {
    const { warnWhenUnsavedChanges } = useContext(RefineContext);

    const { warnWhen, setWarnWhen } = useContext(UnsavedWarnContext);

    return { warnWhenUnsavedChanges, warnWhen, setWarnWhen };
};