@progress/kendo-react-grid
Version:
React Data Grid (Table) provides 100+ ready-to-use data grid features. KendoReact Grid package
57 lines (56 loc) • 1.69 kB
TypeScript
/**
* @license
*-------------------------------------------------------------------------------------------
* Copyright © 2026 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the package root for more information
*-------------------------------------------------------------------------------------------
*/
import * as React from 'react';
/**
* Represents the props for the useSmartBoxPopup hook.
*
* @hidden
*/
export interface UseSmartBoxPopupProps {
/**
* Callback function fired when the popup opens.
*/
onOpen?: () => void;
/**
* Callback function fired when the popup closes.
*/
onClose?: () => void;
}
/**
* Represents the return value of the useSmartBoxPopup hook.
*
* @hidden
*/
export interface UseSmartBoxPopupReturn {
/**
* Indicates whether the popup is currently open.
*/
isOpen: boolean;
/**
* State setter function for the isOpen state.
*/
setIsOpen: React.Dispatch<React.SetStateAction<boolean>>;
/**
* Function to toggle the popup open/closed state.
*
* @param open - Whether to open (true) or close (false) the popup.
*/
togglePopup: (open: boolean) => void;
}
/**
* Hook to manage SmartBox popup state.
*
* Provides state and functions to control the popup visibility,
* automatically triggering onOpen/onClose callbacks when the state changes.
*
* @param props - The hook properties.
* @returns An object containing the popup state and control functions.
*
* @hidden
*/
export declare function useSmartBoxPopup({ onOpen, onClose }: UseSmartBoxPopupProps): UseSmartBoxPopupReturn;