@devlander/hooks/dist/esm/typings/hooks/web/useOnClickByClassName/useOnClickByClassName.hook.d.ts

Hooks used in projects

import type { UseOnClickByStyleOptions } from "../../../types/on-click-by-style-options.type";
interface UseOnClickByStyleOptionsForWeb extends UseOnClickByStyleOptions {
    className?: string;
    onClick?: () => void;
}
/**
 * `useOnClickByStyleForWeb` hook is designed to handle click actions on specific elements within a clickable area on the web.
 * It ensures the action is only triggered when the user interacts with an element containing a designated className.
 *
 * @param {UseOnClickByStyleOptionsForWeb} options - The options for the hook.
 * @param {string} options.className - The className to look for. Defaults to 'onclick-class'.
 * @param {() => void} options.onClick - The callback function to execute when the desired class is clicked.
 *
 * @returns {Function} A handler function to be used in a clickable component.
 */
export declare function useOnClickByClassName({ className, onClick, }: UseOnClickByStyleOptionsForWeb): (event: any) => void;
export {};