@cerberus-design/react/dist/hooks/useToggle.d.cts

The Cerberus Design React component library.

import { ChangeEvent } from 'react';
/**
 * This module provides a hook for using a toggle.
 * @module useToggle
 */
export interface UseToggleOptions {
    /**
     * The initial checked state.
     */
    checked?: string;
    /**
     * Called when the checked state changes.
     */
    onChange?: (e: ChangeEvent<HTMLInputElement>) => void;
}
export interface ToggleHookReturn {
    /**
     * The checked state.
     */
    checked: string;
    /**
     * A custom handler to be called when the checked state changes.
     */
    handleChange: (e: ChangeEvent<HTMLInputElement>) => void;
}
/**
 * @deprecated Will be removed in v1. Use ToggleParts instead.
 */
export declare function useToggle(options?: UseToggleOptions): ToggleHookReturn;