Back to Fluentui

React Spinner.Api

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

4.40.2-hotfix22.1 KB
Original Source

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

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 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 type { Slot } from '@fluentui/react-utilities';
import type { SlotClassNames } from '@fluentui/react-utilities';

// @public
export const renderSpinner_unstable: (state: SpinnerState) => JSXElement;

// @public
export const Spinner: ForwardRefComponent<SpinnerProps>;

// @public (undocumented)
export const spinnerClassNames: SlotClassNames<SpinnerSlots>;

// @internal (undocumented)
export const SpinnerContextProvider: React_2.Provider<SpinnerContextValue | undefined>;

// @internal (undocumented)
export type SpinnerContextValue = Pick<SpinnerProps, 'size'>;

// @public
export type SpinnerProps = Omit<ComponentProps<SpinnerSlots>, 'size'> & {
    appearance?: 'primary' | 'inverted';
    delay?: number;
    labelPosition?: 'above' | 'below' | 'before' | 'after';
    size?: 'extra-tiny' | 'tiny' | 'extra-small' | 'small' | 'medium' | 'large' | 'extra-large' | 'huge';
};

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

// @public
export type SpinnerState = ComponentState<SpinnerSlots> & Required<Pick<SpinnerProps, 'appearance' | 'delay' | 'labelPosition' | 'size'>> & {
    shouldRenderSpinner: boolean;
};

// @public
export const useSpinner_unstable: (props: SpinnerProps, ref: React_2.Ref<HTMLElement>) => SpinnerState;

// @internal (undocumented)
export const useSpinnerContext: () => SpinnerContextValue;

// @public
export const useSpinnerStyles_unstable: (state: SpinnerState) => SpinnerState;

// (No @packageDocumentation comment for this package)