Spaces:
Sleeping
Sleeping
File size: 2,791 Bytes
56fda74 |
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 |
import * as React from 'react';
import { OverridableStringUnion } from '@mui/types';
import { SxProps } from '@mui/system';
import { PropTypes, Theme } from '..';
import { ExtendButtonBase, ExtendButtonBaseTypeMap } from '../ButtonBase';
import { OverrideProps } from '../OverridableComponent';
import { FabClasses } from './fabClasses';
export interface FabPropsVariantOverrides {}
export interface FabPropsSizeOverrides {}
export interface FabPropsColorOverrides {}
export interface FabOwnProps {
/**
* The content of the component.
*/
children?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FabClasses>;
/**
* 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<
PropTypes.Color | 'success' | 'error' | 'info' | 'warning',
FabPropsColorOverrides
>;
/**
* If `true`, the component is disabled.
* @default false
*/
disabled?: boolean;
/**
* If `true`, the keyboard focus ripple is disabled.
* @default false
*/
disableFocusRipple?: boolean;
/**
* If `true`, the ripple effect is disabled.
*/
disableRipple?: boolean;
/**
* The URL to link to when the button is clicked.
* If defined, an `a` element will be used as the root node.
*/
href?: string;
/**
* The size of the component.
* `small` is equivalent to the dense button styling.
* @default 'large'
*/
size?: OverridableStringUnion<'small' | 'medium' | 'large', FabPropsSizeOverrides>;
/**
* The variant to use.
* @default 'circular'
*/
variant?: OverridableStringUnion<'circular' | 'extended', FabPropsVariantOverrides>;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme>;
}
export type FabTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'button',
> = ExtendButtonBaseTypeMap<{
props: AdditionalProps & FabOwnProps;
defaultComponent: RootComponent;
}>;
/**
*
* Demos:
*
* - [Floating Action Button](https://mui.com/material-ui/react-floating-action-button/)
*
* API:
*
* - [Fab API](https://mui.com/material-ui/api/fab/)
* - inherits [ButtonBase API](https://mui.com/material-ui/api/button-base/)
*/
declare const Fab: ExtendButtonBase<FabTypeMap>;
export type FabProps<
RootComponent extends React.ElementType = FabTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<FabTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType;
};
export default Fab;
|