Back to Fluentui

React Checkbox.Api

packages/react-components/react-checkbox/library/etc/react-checkbox.api.md

4.40.2-hotfix22.0 KB
Original Source

API Report File for "@fluentui/react-checkbox"

Do not edit this file. It is a report generated by API Extractor.

ts

import { ComponentProps } from '@fluentui/react-utilities';
import { ComponentState } from '@fluentui/react-utilities';
import type { ForwardRefComponent } from '@fluentui/react-utilities';
import type { JSXElement } from '@fluentui/react-utilities';
import { Label } from '@fluentui/react-label';
import * as React_2 from 'react';
import { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public
export const Checkbox: ForwardRefComponent<CheckboxProps>;

// @public (undocumented)
export const checkboxClassNames: SlotClassNames<CheckboxSlots>;

// @public
export interface CheckboxOnChangeData {
    // (undocumented)
    checked: 'mixed' | boolean;
}

// @public
export type CheckboxProps = Omit<ComponentProps<Partial<CheckboxSlots>, 'input'>, 'checked' | 'defaultChecked' | 'onChange' | 'size'> & {
    checked?: 'mixed' | boolean;
    children?: never;
    defaultChecked?: 'mixed' | boolean;
    labelPosition?: 'before' | 'after';
    onChange?: (ev: React_2.ChangeEvent<HTMLInputElement>, data: CheckboxOnChangeData) => void;
    shape?: 'square' | 'circular';
    size?: 'medium' | 'large';
};

// @public (undocumented)
export type CheckboxSlots = {
    root: NonNullable<Slot<'span'>>;
    label?: Slot<typeof Label>;
    input: NonNullable<Slot<'input'>>;
    indicator: Slot<'div', 'span'>;
};

// @public
export type CheckboxState = ComponentState<CheckboxSlots> & Required<Pick<CheckboxProps, 'checked' | 'disabled' | 'labelPosition' | 'shape' | 'size'>>;

// @public (undocumented)
export const renderCheckbox_unstable: (state: CheckboxState) => JSXElement;

// @public
export const useCheckbox_unstable: (props: CheckboxProps, ref: React_2.Ref<HTMLInputElement>) => CheckboxState;

// @public
export const useCheckboxStyles_unstable: (state: CheckboxState) => CheckboxState;

// (No @packageDocumentation comment for this package)