@primer/react-brand/lib/forms/Checkbox/Checkbox.d.ts

Primer Brand is a GitHub's design system for creating React-based marketing websites and digital experiences.

import React, { type InputHTMLAttributes } from 'react';
import type { BaseProps } from '../../component-helpers';
import type { FormValidationStatus } from '../form-types';
export type CheckboxProps = {
    /**
     * Apply indeterminate visual appearance to the checkbox
     */
    indeterminate?: boolean;
    /**
     * Apply inactive visual appearance to the checkbox
     */
    disabled?: boolean;
    /**
     * Indicates whether the checkbox must be checked
     */
    required?: boolean;
    /**
     * Only used to inform ARIA attributes. Individual checkboxes do not have validation styles.
     */
    validationStatus?: FormValidationStatus;
    /**
     * A unique value that is never shown to the user.
     * Used during form submission and to identify which checkbox inputs are selected
     */
    value?: string;
} & Exclude<InputHTMLAttributes<HTMLInputElement>, 'value'> & BaseProps<HTMLInputElement>;
export declare const Checkbox: React.ForwardRefExoticComponent<Omit<CheckboxProps, "ref"> & React.RefAttributes<unknown>>;