Blame view

天文台pc/tianwentai-ui/node_modules/@mui/material/Avatar/Avatar.d.ts 3.92 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
  import * as React from 'react';
  import { SxProps } from '@mui/system';
  import { OverridableStringUnion } from '@mui/types';
  import { Theme } from "../styles/index.js";
  import { OverridableComponent, OverrideProps } from "../OverridableComponent/index.js";
  import { AvatarClasses } from "./avatarClasses.js";
  import { CreateSlotsAndSlotProps, SlotProps } from "../utils/types.js";
  import { SvgIconProps } from "../SvgIcon/index.js";
  export interface AvatarSlots {
    /**
     * The component that renders the root slot.
     * @default 'div'
     */
    root: React.ElementType;
    /**
     * The component that renders the img slot.
     * @default 'img'
     */
    img: React.ElementType;
    /**
     * The component that renders the fallback slot.
     * @default Person icon
     */
    fallback: React.ElementType;
  }
  export interface AvatarPropsVariantOverrides {}
  export interface AvatarRootSlotPropsOverrides {}
  export interface AvatarImgSlotPropsOverrides {}
  export interface AvatarFallbackSlotPropsOverrides {}
  export type AvatarSlotsAndSlotProps = CreateSlotsAndSlotProps<AvatarSlots, {
    /**
     * Props forwarded to the root slot.
     * By default, the available props are based on the div element.
     */
    root: SlotProps<'div', AvatarRootSlotPropsOverrides, AvatarOwnProps>;
    /**
     * Props forwarded to the img slot.
     * By default, the available props are based on the img element.
     */
    img: SlotProps<'img', AvatarImgSlotPropsOverrides, AvatarOwnProps>;
    /**
     * Props forwarded to the fallback slot.
     * By default, the available props are based on the [SvgIcon](https://mui.com/material-ui/api/svg-icon/#props) component.
     */
    fallback: SlotProps<React.ElementType<SvgIconProps>, AvatarFallbackSlotPropsOverrides, AvatarOwnProps>;
  }>;
  export interface AvatarOwnProps {
    /**
     * Used in combination with `src` or `srcSet` to
     * provide an alt attribute for the rendered `img` element.
     */
    alt?: string;
    /**
     * Used to render icon or text elements inside the Avatar if `src` is not set.
     * This can be an element, or just a string.
     */
    children?: React.ReactNode;
    /**
     * Override or extend the styles applied to the component.
     */
    classes?: Partial<AvatarClasses>;
    /**
     * [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/img#attributes) applied to the `img` element if the component is used to display an image.
     * It can be used to listen for the loading error event.
     * @deprecated Use `slotProps.img` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
     */
    imgProps?: React.ImgHTMLAttributes<HTMLImageElement> & {
      sx?: SxProps<Theme>;
    };
    /**
     * The `sizes` attribute for the `img` element.
     */
    sizes?: string;
    /**
     * The `src` attribute for the `img` element.
     */
    src?: string;
    /**
     * The `srcSet` attribute for the `img` element.
     * Use this attribute for responsive image display.
     */
    srcSet?: string;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: SxProps<Theme>;
    /**
     * The shape of the avatar.
     * @default 'circular'
     */
    variant?: OverridableStringUnion<'circular' | 'rounded' | 'square', AvatarPropsVariantOverrides>;
  }
  export interface AvatarTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'div'> {
    props: AdditionalProps & AvatarOwnProps & AvatarSlotsAndSlotProps;
    defaultComponent: RootComponent;
  }
  
  /**
   *
   * Demos:
   *
   * - [Avatar](https://mui.com/material-ui/react-avatar/)
   *
   * API:
   *
   * - [Avatar API](https://mui.com/material-ui/api/avatar/)
   */
  declare const Avatar: OverridableComponent<AvatarTypeMap>;
  export type AvatarProps<RootComponent extends React.ElementType = AvatarTypeMap['defaultComponent'], AdditionalProps = {}> = OverrideProps<AvatarTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
    component?: React.ElementType;
  };
  export default Avatar;