UNPKG

1.48 kBTypeScriptView Raw
1import * as React from 'react';
2import { StandardProps } from '..';
3
4export interface PaperProps
5 extends StandardProps<React.HTMLAttributes<HTMLDivElement>, PaperClassKey> {
6 /**
7 * The content of the component.
8 */
9 children?: React.ReactNode;
10 /**
11 * The component used for the root node.
12 * Either a string to use a HTML element or a component.
13 */
14 component?: React.ElementType<React.HTMLAttributes<HTMLElement>>;
15 /**
16 * Shadow depth, corresponds to `dp` in the spec.
17 * It accepts values between 0 and 24 inclusive.
18 */
19 elevation?: number;
20 /**
21 * If `true`, rounded corners are disabled.
22 */
23 square?: boolean;
24 /**
25 * The variant to use.
26 */
27 variant?: 'elevation' | 'outlined';
28}
29
30export type PaperClassKey =
31 | 'root'
32 | 'rounded'
33 | 'outlined'
34 | 'elevation0'
35 | 'elevation1'
36 | 'elevation2'
37 | 'elevation3'
38 | 'elevation4'
39 | 'elevation5'
40 | 'elevation6'
41 | 'elevation7'
42 | 'elevation8'
43 | 'elevation9'
44 | 'elevation10'
45 | 'elevation11'
46 | 'elevation12'
47 | 'elevation13'
48 | 'elevation14'
49 | 'elevation15'
50 | 'elevation16'
51 | 'elevation17'
52 | 'elevation18'
53 | 'elevation19'
54 | 'elevation20'
55 | 'elevation21'
56 | 'elevation22'
57 | 'elevation23'
58 | 'elevation24';
59
60/**
61 *
62 * Demos:
63 *
64 * - [Cards](https://mui.com/components/cards/)
65 * - [Paper](https://mui.com/components/paper/)
66 *
67 * API:
68 *
69 * - [Paper API](https://mui.com/api/paper/)
70 */
71export default function Paper(props: PaperProps): JSX.Element;