@engie-group/fluid-design-system-react/lib/components/toggle/NJToggle.d.ts

Fluid Design System React

import type { ToggleProperties } from '@engie-group/fluid-types';
import React from 'react';
export declare const NJToggle: React.ForwardRefExoticComponent<ToggleProperties & Omit<Omit<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "onChange" | "size"> & {
    /**
     *  on or off value returned with onChange function
     *  */
    values?: {
        off: string | number | boolean;
        on: string | number | boolean;
    };
    /**
     * Children can only be an icon, with `data-child-name="njToggleIcon"` attribute
     */
    children?: React.ReactNode;
    /**
     *  use onChange function to get checked status and value from parent component
     *  */
    onChange?: (event: React.ChangeEvent<HTMLInputElement>, checked: boolean, value: string | number | boolean) => void;
} & React.RefAttributes<HTMLInputElement>>;
export type NJToggleProps = ToggleProperties & Omit<React.ComponentPropsWithoutRef<'input'>, 'size' | 'onChange'> & {
    /**
     *  on or off value returned with onChange function
     *  */
    values?: {
        off: string | number | boolean;
        on: string | number | boolean;
    };
    /**
     * Children can only be an icon, with `data-child-name="njToggleIcon"` attribute
     */
    children?: React.ReactNode;
    /**
     *  use onChange function to get checked status and value from parent component
     *  */
    onChange?: (event: React.ChangeEvent<HTMLInputElement>, checked: boolean, value: string | number | boolean) => void;
};