87 lines
No EOL
3 KiB
TypeScript
87 lines
No EOL
3 KiB
TypeScript
import * as React from 'react';
|
|
import { SxProps } from '@mui/system';
|
|
import { OverridableStringUnion } from '@mui/types';
|
|
import { Theme } from "../styles/index.js";
|
|
import { InternalStandardProps as StandardProps } from "../internal/index.js";
|
|
import { CreateSlotsAndSlotProps, SlotProps } from "../utils/types.js";
|
|
import { SwitchBaseProps } from "../internal/SwitchBase.js";
|
|
import { RadioClasses } from "./radioClasses.js";
|
|
export interface RadioPropsSizeOverrides {}
|
|
export interface RadioPropsColorOverrides {}
|
|
export interface RadioRootSlotPropsOverrides {}
|
|
export interface RadioInputSlotPropsOverrides {}
|
|
export interface RadioSlots {
|
|
/**
|
|
* The component that renders the root slot.
|
|
* @default SwitchBase
|
|
*/
|
|
root: React.ElementType;
|
|
/**
|
|
* The component that renders the input slot.
|
|
* @default SwitchBase's input
|
|
*/
|
|
input: React.ElementType;
|
|
}
|
|
export type RadioSlotsAndSlotProps = CreateSlotsAndSlotProps<RadioSlots, {
|
|
/**
|
|
* Props forwarded to the root slot.
|
|
* By default, the avaible props are based on the span element.
|
|
*/
|
|
root: SlotProps<React.ElementType<SwitchBaseProps>, RadioRootSlotPropsOverrides, RadioOwnerState>;
|
|
/**
|
|
* Props forwarded to the input slot.
|
|
* By default, the avaible props are based on the input element.
|
|
*/
|
|
input: SlotProps<'input', RadioInputSlotPropsOverrides, RadioOwnerState>;
|
|
}>;
|
|
export interface RadioProps extends StandardProps<SwitchBaseProps, 'checkedIcon' | 'color' | 'icon' | 'type' | 'slots' | 'slotProps'>, RadioSlotsAndSlotProps {
|
|
/**
|
|
* The icon to display when the component is checked.
|
|
* @default <RadioButtonIcon checked />
|
|
*/
|
|
checkedIcon?: React.ReactNode;
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
*/
|
|
classes?: Partial<RadioClasses>;
|
|
/**
|
|
* 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<'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | 'default', RadioPropsColorOverrides>;
|
|
/**
|
|
* If `true`, the component is disabled.
|
|
*/
|
|
disabled?: boolean;
|
|
/**
|
|
* The icon to display when the component is unchecked.
|
|
* @default <RadioButtonIcon />
|
|
*/
|
|
icon?: React.ReactNode;
|
|
/**
|
|
* The size of the component.
|
|
* `small` is equivalent to the dense radio styling.
|
|
* @default 'medium'
|
|
*/
|
|
size?: OverridableStringUnion<'small' | 'medium', RadioPropsSizeOverrides>;
|
|
/**
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx?: SxProps<Theme>;
|
|
}
|
|
export interface RadioOwnerState extends Omit<RadioProps, 'slots' | 'slotProps'> {}
|
|
|
|
/**
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Radio Group](https://mui.com/material-ui/react-radio-button/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [Radio API](https://mui.com/material-ui/api/radio/)
|
|
* - inherits [ButtonBase API](https://mui.com/material-ui/api/button-base/)
|
|
*/
|
|
export default function Radio(props: RadioProps): React.JSX.Element; |