77 lines
2.0 KiB
TypeScript
77 lines
2.0 KiB
TypeScript
|
import * as React from 'react';
|
||
|
|
import { SxProps } from '@mui/system';
|
||
|
|
import { OverridableStringUnion } from '@mui/types';
|
||
|
|
import { Theme } from '..';
|
||
|
|
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
|
||
|
|
import { SkeletonClasses } from './skeletonClasses';
|
||
|
|
|
||
|
|
export interface SkeletonPropsVariantOverrides {}
|
||
|
|
|
||
|
|
export interface SkeletonOwnProps {
|
||
|
|
/**
|
||
|
|
* The animation.
|
||
|
|
* If `false` the animation effect is disabled.
|
||
|
|
* @default 'pulse'
|
||
|
|
*/
|
||
|
|
animation?: 'pulse' | 'wave' | false;
|
||
|
|
/**
|
||
|
|
* Optional children to infer width and height from.
|
||
|
|
*/
|
||
|
|
children?: React.ReactNode;
|
||
|
|
/**
|
||
|
|
* Override or extend the styles applied to the component.
|
||
|
|
*/
|
||
|
|
classes?: Partial<SkeletonClasses>;
|
||
|
|
/**
|
||
|
|
* Height of the skeleton.
|
||
|
|
* Useful when you don't want to adapt the skeleton to a text element but for instance a card.
|
||
|
|
*/
|
||
|
|
height?: number | string;
|
||
|
|
/**
|
||
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
||
|
|
*/
|
||
|
|
sx?: SxProps<Theme>;
|
||
|
|
/**
|
||
|
|
* The type of content that will be rendered.
|
||
|
|
* @default 'text'
|
||
|
|
*/
|
||
|
|
variant?: OverridableStringUnion<
|
||
|
|
'text' | 'rectangular' | 'rounded' | 'circular',
|
||
|
|
SkeletonPropsVariantOverrides
|
||
|
|
>;
|
||
|
|
/**
|
||
|
|
* Width of the skeleton.
|
||
|
|
* Useful when the skeleton is inside an inline element with no width of its own.
|
||
|
|
*/
|
||
|
|
width?: number | string;
|
||
|
|
}
|
||
|
|
|
||
|
|
export interface SkeletonTypeMap<
|
||
|
|
AdditionalProps = {},
|
||
|
|
RootComponent extends React.ElementType = 'span',
|
||
|
|
> {
|
||
|
|
props: AdditionalProps & SkeletonOwnProps;
|
||
|
|
defaultComponent: RootComponent;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* Demos:
|
||
|
|
*
|
||
|
|
* - [Skeleton](https://mui.com/material-ui/react-skeleton/)
|
||
|
|
*
|
||
|
|
* API:
|
||
|
|
*
|
||
|
|
* - [Skeleton API](https://mui.com/material-ui/api/skeleton/)
|
||
|
|
*/
|
||
|
|
declare const Skeleton: OverridableComponent<SkeletonTypeMap>;
|
||
|
|
|
||
|
|
export type SkeletonProps<
|
||
|
|
RootComponent extends React.ElementType = SkeletonTypeMap['defaultComponent'],
|
||
|
|
AdditionalProps = {},
|
||
|
|
> = OverrideProps<SkeletonTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
|
||
|
|
component?: React.ElementType;
|
||
|
|
};
|
||
|
|
|
||
|
|
export default Skeleton;
|