@kubit-ui-web/react-components
Version:
Kubit React Components is a customizable, accessible library of React web components, designed to enhance your application's user experience
16 lines (15 loc) • 485 B
TypeScript
import React from 'react';
interface ReturnValue {
innerRef: React.MutableRefObject<HTMLElement | null>;
isOverflow: boolean;
}
declare const useIsOverflow: () => ReturnValue;
/**
* @description
* Hook to check if the element is overflow
* @param {React.MutableRefObject<HTMLElement | null>} ref - Ref of the element.
* @returns {boolean} - Return if the element is overflow.
* @example
* const {innerRef, isOverflow} = useIsOverflow();
*/
export default useIsOverflow;