import React from "react"; import type { SpaceProps } from "styled-system"; import { type ComponentVariant } from "../NDSProvider/ComponentVariantContext"; import type { DefaultNDSThemeType } from "../theme"; interface ToggleProps extends SpaceProps { /** * @see FieldLabel */ hint?: string; /** * @note This prop is required when checked is set. It will not be optional in * a future version. */ onChange?: (e: React.ChangeEvent) => void; variant?: ComponentVariant; /** * Controls whether the toggle is checked or not. * @note This prop will be required in a future version. */ checked?: boolean; /** * @deprecated use checked instead */ toggled?: boolean; disabled?: boolean; onText?: string; offText?: string; id?: string; className?: string; required?: boolean; /** * @see FieldLabel */ helpText?: string; /** * @see FieldLabel */ labelText?: string; requirementText?: string; error?: boolean; ref?: React.Ref; name?: string; theme?: DefaultNDSThemeType; "data-testid"?: string; /** * @deprecated use onChange instead */ onClick?: (e: React.MouseEvent) => void; /** * @deprecated set the default state through the checked prop instead */ defaultToggled?: boolean; } declare const Toggle: React.ForwardRefExoticComponent & React.RefAttributes>; export default Toggle;