132 lines
3.9 KiB
TypeScript
132 lines
3.9 KiB
TypeScript
import * as React from 'react';
|
|
import { DistributiveOmit, OverridableStringUnion } from '@mui/types';
|
|
import { SxProps } from '@mui/system';
|
|
import { Theme } from '../styles';
|
|
import { ExtendButtonBase, ExtendButtonBaseTypeMap } from '../ButtonBase';
|
|
import { OverrideProps, OverridableComponent, OverridableTypeMap } from '../OverridableComponent';
|
|
import { ButtonClasses } from './buttonClasses';
|
|
|
|
export interface ButtonPropsVariantOverrides {}
|
|
|
|
export interface ButtonPropsColorOverrides {}
|
|
|
|
export interface ButtonPropsSizeOverrides {}
|
|
|
|
export interface ButtonOwnProps {
|
|
/**
|
|
* The content of the component.
|
|
*/
|
|
children?: React.ReactNode;
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
*/
|
|
classes?: Partial<ButtonClasses>;
|
|
/**
|
|
* 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 'primary'
|
|
*/
|
|
color?: OverridableStringUnion<
|
|
'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning',
|
|
ButtonPropsColorOverrides
|
|
>;
|
|
/**
|
|
* If `true`, the component is disabled.
|
|
* @default false
|
|
*/
|
|
disabled?: boolean;
|
|
/**
|
|
* If `true`, no elevation is used.
|
|
* @default false
|
|
*/
|
|
disableElevation?: boolean;
|
|
/**
|
|
* If `true`, the keyboard focus ripple is disabled.
|
|
* @default false
|
|
*/
|
|
disableFocusRipple?: boolean;
|
|
/**
|
|
* Element placed after the children.
|
|
*/
|
|
endIcon?: React.ReactNode;
|
|
/**
|
|
* If `true`, the button will take up the full width of its container.
|
|
* @default false
|
|
*/
|
|
fullWidth?: 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 'medium'
|
|
*/
|
|
size?: OverridableStringUnion<'small' | 'medium' | 'large', ButtonPropsSizeOverrides>;
|
|
/**
|
|
* Element placed before the children.
|
|
*/
|
|
startIcon?: React.ReactNode;
|
|
/**
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx?: SxProps<Theme>;
|
|
/**
|
|
* The variant to use.
|
|
* @default 'text'
|
|
*/
|
|
variant?: OverridableStringUnion<'text' | 'outlined' | 'contained', ButtonPropsVariantOverrides>;
|
|
}
|
|
|
|
export type ButtonTypeMap<
|
|
AdditionalProps = {},
|
|
RootComponent extends React.ElementType = 'button',
|
|
> = ExtendButtonBaseTypeMap<{
|
|
props: AdditionalProps & ButtonOwnProps;
|
|
defaultComponent: RootComponent;
|
|
}>;
|
|
|
|
/**
|
|
* utility to create component types that inherit props from ButtonBase.
|
|
* This component has an additional overload if the `href` prop is set which
|
|
* can make extension quite tricky
|
|
*/
|
|
export interface ExtendButtonTypeMap<TypeMap extends OverridableTypeMap> {
|
|
props: TypeMap['props'] &
|
|
(TypeMap['props'] extends { classes?: Record<string, string> }
|
|
? DistributiveOmit<ButtonTypeMap['props'], 'classes'>
|
|
: ButtonTypeMap['props']);
|
|
defaultComponent: TypeMap['defaultComponent'];
|
|
}
|
|
|
|
export type ExtendButton<TypeMap extends OverridableTypeMap> = ((
|
|
props: { href: string } & OverrideProps<ExtendButtonBaseTypeMap<TypeMap>, 'a'>,
|
|
) => JSX.Element) &
|
|
OverridableComponent<ExtendButtonBaseTypeMap<TypeMap>>;
|
|
|
|
/**
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Button Group](https://mui.com/material-ui/react-button-group/)
|
|
* - [Button](https://mui.com/material-ui/react-button/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [Button API](https://mui.com/material-ui/api/button/)
|
|
* - inherits [ButtonBase API](https://mui.com/material-ui/api/button-base/)
|
|
*/
|
|
declare const Button: ExtendButtonBase<ButtonTypeMap>;
|
|
|
|
export type ButtonProps<
|
|
RootComponent extends React.ElementType = ButtonTypeMap['defaultComponent'],
|
|
AdditionalProps = {},
|
|
> = OverrideProps<ButtonTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
|
|
component?: React.ElementType;
|
|
};
|
|
|
|
export default Button;
|