@carbon/ibm-products
Version:
Carbon for IBM Products
20 lines • 786 B
TypeScript
/**
* Copyright IBM Corp. 2025, 2025
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
interface UseCollapsibleHeaderOptions {
container: HTMLDivElement | null;
triggerCollapse: (collapsed: boolean) => void;
disableHeaderCollapse?: boolean;
}
/**
* Custom hook to manage collapsible header behavior based on scroll and drag gestures.
*
* This avoids relying solely on scroll events because collapsing the header can
* remove scrollable space, preventing further scroll events from firing.
*/
export declare function useCollapsible({ container, triggerCollapse, disableHeaderCollapse, }: UseCollapsibleHeaderOptions): void;
export {};
//# sourceMappingURL=useCollapsible.d.ts.map