carbon-react/esm/__internal__/checkable-input/checkable-input.component.d.ts

A library of reusable React components for easily building user interfaces.

import React from "react";
import { CommonHiddenCheckableInputProps } from "./hidden-checkable-input.component";
import { ValidationProps } from "../validations";
export interface CommonCheckableInputProps extends ValidationProps, CommonHiddenCheckableInputProps {
    /** If true, the component will be disabled */
    disabled?: boolean;
    /** @private @ignore */
    loading?: boolean;
    /** Help content to be displayed under an input */
    fieldHelp?: React.ReactNode;
    /**
     * If true, the FieldHelp will be displayed inline
     * To be used with labelInline prop set to true
     */
    fieldHelpInline?: boolean;
    /** Unique Identifier for the input. Will use a randomly generated GUID if none is provided */
    id?: string;
    /** Sets percentage-based input width */
    inputWidth?: number;
    /** Label content */
    label?: React.ReactNode;
    /** The content for the help tooltip, to appear next to the Label */
    labelHelp?: React.ReactNode;
    /** Spacing between label and a field for inline label, given number will be multiplied by base spacing unit (8) */
    labelSpacing?: 1 | 2;
    /** Label width */
    labelWidth?: number;
    /** Flag to configure component as mandatory */
    required?: boolean;
    /** If true the label switches position with the input */
    reverse?: boolean;
    /** Size of the component */
    size?: "small" | "large";
    /** Prop to specify the aria-labelledby attribute of the input */
    ariaLabelledBy?: string;
    /** When true, displays validation icon on label */
    validationOnLabel?: boolean;
}
export interface CheckableInputProps extends CommonCheckableInputProps {
    /** Used to set the visible aspect of the input (i.e. the checkbox sprite, input slider etc) */
    children?: React.ReactNode;
    /** HTML type attribute of the input */
    type: string;
    /** Value passed to the input */
    value?: string;
    /** When true label is inline */
    labelInline?: boolean;
    /** Whether this component resides on a dark background */
    isDarkBackground?: boolean;
}
declare const CheckableInput: React.ForwardRefExoticComponent<CheckableInputProps & React.RefAttributes<HTMLInputElement>>;
export default CheckableInput;