UNPKG

854 BTypeScriptView Raw
1import * as React from 'react';
2import { StandardProps } from '@material-ui/core';
3
4export interface TimelineDotProps extends StandardProps<{}, TimelineDotClassKey> {
5 /**
6 * The content of the component.
7 */
8 children?: React.ReactNode;
9 /**
10 * The dot can appear filled or outlined.
11 */
12 variant?: 'default' | 'outlined';
13 /**
14 * The dot can have a different colors.
15 */
16 color?: 'inherit' | 'primary' | 'secondary' | 'grey';
17}
18
19export type TimelineDotClassKey =
20 | 'root'
21 | 'defaultDefault'
22 | 'defaultPrimary'
23 | 'defaultSecondary'
24 | 'outlinedDefault'
25 | 'outlinedPrimary'
26 | 'outlinedSecondary';
27
28/**
29 *
30 * Demos:
31 *
32 * - [Timeline](https://mui.com/components/timeline/)
33 *
34 * API:
35 *
36 * - [TimelineDot API](https://mui.com/api/timeline-dot/)
37 */
38export default function TimelineDot(props: TimelineDotProps): JSX.Element;