Skip to content

react-label.api.md

Latest commit

 

History

History
59 lines (43 loc) · 1.8 KB

react-label.api.md

File metadata and controls

59 lines (43 loc) · 1.8 KB

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

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

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

// @public
export const Label: ForwardRefComponent<LabelProps>;

// @public
export type LabelBaseProps = Omit<LabelProps, 'size' | 'weight'>;

// @public
export type LabelBaseState = Omit<LabelState, 'size' | 'weight'>;

// @public (undocumented)
export const labelClassNames: SlotClassNames<LabelSlots>;

// @public
export type LabelProps = Omit<ComponentProps<LabelSlots>, 'required'> & {
    disabled?: boolean;
    required?: boolean | Slot<'span'>;
    size?: 'small' | 'medium' | 'large';
    weight?: 'regular' | 'semibold';
};

// @public (undocumented)
export type LabelSlots = {
    root: Slot<'label'>;
    required?: Slot<'span'>;
    icon?: Slot<'span'>;
};

// @public
export type LabelState = ComponentState<LabelSlots> & Required<Pick<LabelProps, 'disabled' | 'size' | 'weight'>>;

// @public
export const renderLabel_unstable: (state: LabelBaseState) => JSXElement;

// @public
export const useLabel_unstable: (props: LabelProps, ref: React_2.Ref<HTMLElement>) => LabelState;

// @public
export const useLabelBase_unstable: (props: LabelBaseProps, ref: React_2.Ref<HTMLLabelElement>) => LabelBaseState;

// @public
export const useLabelStyles_unstable: (state: LabelState) => LabelState;

// (No @packageDocumentation comment for this package)