Back to Fluentui

React Infolabel.Api

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

4.40.2-hotfix22.7 KB
Original Source

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

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

ts

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

// @public
export const InfoButton: ForwardRefComponent<InfoButtonProps>;

// @public (undocumented)
export const infoButtonClassNames: SlotClassNames<InfoButtonSlots>;

// @public
export type InfoButtonProps = Omit<ComponentProps<Partial<InfoButtonSlots>>, 'disabled' | 'popover'> & {
    size?: 'small' | 'medium' | 'large';
    inline?: boolean;
    popover?: InfoButtonSlots['popover'];
};

// @public (undocumented)
export type InfoButtonSlots = {
    root: NonNullable<Slot<'button'>>;
    popover: NonNullable<Slot<Partial<Omit<PopoverProps, 'openOnHover'>>>>;
    info: NonNullable<Slot<typeof PopoverSurface>>;
};

// @public
export type InfoButtonState = ComponentState<InfoButtonSlots> & Required<Pick<InfoButtonProps, 'inline' | 'size'>>;

// @public
export const InfoLabel: ForwardRefComponent<InfoLabelProps>;

// @public (undocumented)
export const infoLabelClassNames: SlotClassNames<InfoLabelSlots>;

// @public
export type InfoLabelProps = ComponentProps<Partial<InfoLabelSlots>, 'label'> & {
    info?: InfoButtonProps['info'];
};

// @public (undocumented)
export type InfoLabelSlots = {
    root: NonNullable<Slot<'span'>>;
    label: NonNullable<Slot<typeof Label>>;
    infoButton: Slot<typeof InfoButton>;
};

// @public
export type InfoLabelState = ComponentState<InfoLabelSlots> & Pick<InfoLabelProps, 'size'>;

// @public
export const renderInfoButton_unstable: (state: InfoButtonState) => JSXElement;

// @public
export const renderInfoLabel_unstable: (state: InfoLabelState) => JSXElement;

// @public
export const useInfoButton_unstable: (props: InfoButtonProps, ref: React_2.Ref<HTMLButtonElement>) => InfoButtonState;

// @public
export const useInfoButtonStyles_unstable: (state: InfoButtonState) => InfoButtonState;

// @public
export const useInfoLabel_unstable: (props: InfoLabelProps, ref: React_2.Ref<HTMLLabelElement>) => InfoLabelState;

// @public
export const useInfoLabelStyles_unstable: (state: InfoLabelState) => InfoLabelState;

// (No @packageDocumentation comment for this package)