@craftercms/studio-ui/hooks/useEnhancedDialogState.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

export interface EnhancedDialogState {
  open: boolean;
  isMinimized?: boolean;
  isFullScreen?: boolean;
  hasPendingChanges?: boolean;
  isSubmitting?: boolean;
}
export interface onSubmittingAndOrPendingChangeProps {
  hasPendingChanges?: boolean;
  isSubmitting?: boolean;
}
export declare function useEnhancedDialogState(initialState?: Partial<EnhancedDialogState>): {
  onOpen: () => void;
  onClose: () => void;
  onResetState: () => void;
  onMaximize: () => void;
  onMinimize: () => void;
  onFullScreen: () => void;
  onCancelFullScreen: () => void;
  onSubmittingChange: (isSubmitting: boolean) => void;
  onHasPendingChange: (hasPendingChanges: boolean) => void;
  onSubmittingAndOrPendingChange: ({ isSubmitting, hasPendingChanges }: onSubmittingAndOrPendingChangeProps) => void;
  open: boolean;
  isMinimized?: boolean;
  isFullScreen?: boolean;
  hasPendingChanges?: boolean;
  isSubmitting?: boolean;
};
export default useEnhancedDialogState;