Back to Fluentui

React Skeleton.Api

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

4.40.2-hotfix23.1 KB
Original Source

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

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

// @public
export const renderSkeleton_unstable: (state: SkeletonState, contextValues: SkeletonContextValues) => JSXElement;

// @public
export const renderSkeletonItem_unstable: (state: SkeletonItemState) => JSXElement;

// @public
export const Skeleton: ForwardRefComponent<SkeletonProps>;

// @public (undocumented)
export const skeletonClassNames: SlotClassNames<SkeletonSlots>;

// @public (undocumented)
export const SkeletonContextProvider: React_2.Provider<SkeletonContextValue | undefined>;

// @public (undocumented)
export interface SkeletonContextValue {
    // (undocumented)
    animation?: 'wave' | 'pulse';
    // (undocumented)
    appearance?: 'opaque' | 'translucent';
    // (undocumented)
    shape?: 'circle' | 'square' | 'rectangle';
    // (undocumented)
    size?: SkeletonItemSize;
}

// @public (undocumented)
export const SkeletonItem: ForwardRefComponent<SkeletonItemProps>;

// @public (undocumented)
export const skeletonItemClassNames: SlotClassNames<SkeletonItemSlots>;

// @public
export type SkeletonItemProps = ComponentProps<SkeletonItemSlots> & Pick<SkeletonProps, 'size' | 'shape'> & {
    animation?: 'wave' | 'pulse';
    appearance?: 'opaque' | 'translucent';
};

// @public (undocumented)
export type SkeletonItemSlots = {
    root: Slot<'div', 'span'>;
};

// @public
export type SkeletonItemState = ComponentState<SkeletonItemSlots> & Required<Pick<SkeletonItemProps, 'animation' | 'appearance' | 'size' | 'shape'>>;

// @public
export type SkeletonProps = Omit<ComponentProps<Partial<SkeletonSlots>>, 'width'> & {
    animation?: 'wave' | 'pulse';
    appearance?: 'opaque' | 'translucent';
    width?: number | string;
    size?: SkeletonItemSize;
    shape?: 'circle' | 'square' | 'rectangle';
};

// @public (undocumented)
export type SkeletonSlots = {
    root: NonNullable<Slot<'div', 'span'>>;
};

// @public
export type SkeletonState = ComponentState<SkeletonSlots> & Required<Pick<SkeletonProps, 'animation' | 'appearance'>> & Pick<SkeletonProps, 'size' | 'shape'>;

// @public
export const useSkeleton_unstable: (props: SkeletonProps, ref: React_2.Ref<HTMLElement>) => SkeletonState;

// @public (undocumented)
export const useSkeletonContext: () => SkeletonContextValue;

// @public
export const useSkeletonItem_unstable: (props: SkeletonItemProps, ref: React_2.Ref<HTMLElement>) => SkeletonItemState;

// @public
export const useSkeletonItemStyles_unstable: (state: SkeletonItemState) => SkeletonItemState;

// @public
export const useSkeletonStyles_unstable: (state: SkeletonState) => SkeletonState;

// (No @packageDocumentation comment for this package)