57 lines
1.4 KiB
TypeScript
57 lines
1.4 KiB
TypeScript
|
|
import * as React from 'react';
|
||
|
|
import { StandardProps } from '..';
|
||
|
|
import { SwitchBaseProps, SwitchBaseClassKey } from '../internal/SwitchBase';
|
||
|
|
|
||
|
|
export interface SwitchProps
|
||
|
|
extends StandardProps<SwitchBaseProps, SwitchClassKey, 'checkedIcon' | 'color' | 'icon'> {
|
||
|
|
/**
|
||
|
|
* The icon to display when the component is checked.
|
||
|
|
*/
|
||
|
|
checkedIcon?: React.ReactNode;
|
||
|
|
/**
|
||
|
|
* The color of the component. It supports those theme colors that make sense for this component.
|
||
|
|
*/
|
||
|
|
color?: 'primary' | 'secondary' | 'default';
|
||
|
|
/**
|
||
|
|
* If `true`, the switch will be disabled.
|
||
|
|
*/
|
||
|
|
disabled?: boolean;
|
||
|
|
/**
|
||
|
|
* The icon to display when the component is unchecked.
|
||
|
|
*/
|
||
|
|
icon?: React.ReactNode;
|
||
|
|
/**
|
||
|
|
* The size of the switch.
|
||
|
|
* `small` is equivalent to the dense switch styling.
|
||
|
|
*/
|
||
|
|
size?: 'small' | 'medium';
|
||
|
|
/**
|
||
|
|
* The value of the component. The DOM API casts this to a string.
|
||
|
|
* The browser uses "on" as the default value.
|
||
|
|
*/
|
||
|
|
value?: unknown;
|
||
|
|
}
|
||
|
|
|
||
|
|
export type SwitchClassKey =
|
||
|
|
| SwitchBaseClassKey
|
||
|
|
| 'switchBase'
|
||
|
|
| 'colorPrimary'
|
||
|
|
| 'colorSecondary'
|
||
|
|
| 'sizeSmall'
|
||
|
|
| 'thumb'
|
||
|
|
| 'track';
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* Demos:
|
||
|
|
*
|
||
|
|
* - [Switches](https://mui.com/components/switches/)
|
||
|
|
* - [Transfer List](https://mui.com/components/transfer-list/)
|
||
|
|
*
|
||
|
|
* API:
|
||
|
|
*
|
||
|
|
* - [Switch API](https://mui.com/api/switch/)
|
||
|
|
* - inherits [IconButton API](https://mui.com/api/icon-button/)
|
||
|
|
*/
|
||
|
|
export default function Switch(props: SwitchProps): JSX.Element;
|