@visa/nova-react/checkbox/index.d.ts

Visa Product Design System Nova React library

/**
 *              Copyright (c) 2025 Visa, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **/
import { ElementType, ForwardedRef } from 'react';
export type CheckboxProperties = {
    /** @ignore */
    children?: never;
    /** @ignore */
    className?: string;
} & ({
    /** Whether a checkbox is indeterminate state, only allowable on "input" tag types. This should only be set to true if checked is false. */
    indeterminate?: never;
    /** Tag of Component */
    tag: Exclude<ElementType, 'input'>;
} | {
    /** Whether a checkbox is indeterminate state, only allowable on "input" tag types. This should only be set to true if checked is false. */
    indeterminate?: boolean;
    /** Tag of Component */
    tag?: 'input';
});
/**
 * Interactive element enabling users to select one or more independent options from a group.
 * @docs {@link https://design.visa.com/react/components/checkbox | See Docs}
 * @vgar TODO
 * @wcag TODO
 * @related checkbox-panel
 */
declare const _default: <HTMLElementType = HTMLInputElement>(props: {
    children?: import("react").ReactNode | import("react").ReactNode[];
    ref?: ForwardedRef<HTMLElementType> | undefined;
} & import("react").AllHTMLAttributes<HTMLElementType> & (import("react").SVGAttributes<HTMLElementType> & CheckboxProperties)) => import("react").ReactElement;
export default _default;