Blame view

天文台pc/tianwentai-ui/node_modules/@mui/material/IconButton/IconButton.d.ts 3.5 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
  import * as React from 'react';
  import { SxProps } from '@mui/system';
  import { OverridableStringUnion } from '@mui/types';
  import { Theme } from "../styles/index.js";
  import { ExtendButtonBase, ExtendButtonBaseTypeMap } from "../ButtonBase/index.js";
  import { OverrideProps } from "../OverridableComponent/index.js";
  import { IconButtonClasses } from "./iconButtonClasses.js";
  export interface IconButtonPropsColorOverrides {}
  export interface IconButtonPropsSizeOverrides {}
  export interface IconButtonOwnProps {
    /**
     * The icon to display.
     */
    children?: React.ReactNode;
    /**
     * Override or extend the styles applied to the component.
     */
    classes?: Partial<IconButtonClasses>;
    /**
     * The color of the component.
     * It supports both default and custom theme colors, which can be added as shown in the
     * [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
     * @default 'default'
     */
    color?: OverridableStringUnion<'inherit' | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning', IconButtonPropsColorOverrides>;
    /**
     * If `true`, the component is disabled.
     * @default false
     */
    disabled?: boolean;
    /**
     * If `true`, the  keyboard focus ripple is disabled.
     * @default false
     */
    disableFocusRipple?: boolean;
    /**
     * If given, uses a negative margin to counteract the padding on one
     * side (this is often helpful for aligning the left or right
     * side of the icon with content above or below, without ruining the border
     * size and shape).
     * @default false
     */
    edge?: 'start' | 'end' | false;
    /**
     * If `true`, the loading indicator is visible and the button is disabled.
     * If `true | false`, the loading wrapper is always rendered before the children to prevent [Google Translation Crash](https://github.com/mui/material-ui/issues/27853).
     * @default null
     */
    loading?: boolean | null;
    /**
     * Element placed before the children if the button is in loading state.
     * The node should contain an element with `role="progressbar"` with an accessible name.
     * By default, it renders a `CircularProgress` that is labeled by the button itself.
     * @default <CircularProgress color="inherit" size={16} />
     */
    loadingIndicator?: React.ReactNode;
    /**
     * The size of the component.
     * `small` is equivalent to the dense button styling.
     * @default 'medium'
     */
    size?: OverridableStringUnion<'small' | 'medium' | 'large', IconButtonPropsSizeOverrides>;
    /**
     * The system prop that allows defining system overrides as well as additional CSS styles.
     */
    sx?: SxProps<Theme>;
  }
  export type IconButtonTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'button'> = ExtendButtonBaseTypeMap<{
    props: AdditionalProps & IconButtonOwnProps;
    defaultComponent: RootComponent;
  }>;
  
  /**
   * Refer to the [Icons](https://mui.com/material-ui/icons/) section of the documentation
   * regarding the available icon options.
   *
   * Demos:
   *
   * - [Button](https://mui.com/material-ui/react-button/)
   *
   * API:
   *
   * - [IconButton API](https://mui.com/material-ui/api/icon-button/)
   * - inherits [ButtonBase API](https://mui.com/material-ui/api/button-base/)
   */
  declare const IconButton: ExtendButtonBase<IconButtonTypeMap>;
  export type IconButtonProps<RootComponent extends React.ElementType = IconButtonTypeMap['defaultComponent'], AdditionalProps = {}> = OverrideProps<IconButtonTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
    component?: React.ElementType;
  };
  export default IconButton;