forked from microsoft/fluentui
/
Overlay.types.ts
83 lines (70 loc) · 1.43 KB
/
Overlay.types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
import * as React from 'react';
import { IStyle, ITheme } from '../../Styling';
import { IRefObject, IStyleFunctionOrObject } from '../../Utilities';
/**
* {@docCategory Overlay}
*/
export interface IOverlay {}
/**
* {@docCategory Overlay}
*/
export interface IOverlayProps extends React.HTMLAttributes<HTMLElement> {
/**
* Gets the component ref.
*/
componentRef?: IRefObject<IOverlay>;
/**
* Call to provide customized styling that will layer on top of the variant rules
*/
styles?: IStyleFunctionOrObject<IOverlayStyleProps, IOverlayStyles>;
/**
* Theme provided by HOC.
*/
theme?: ITheme;
/**
* Additional css class to apply to the Overlay
* @defaultvalue undefined
*/
className?: string;
/**
* Whether to use the dark-themed overlay.
* @defaultvalue false
*/
isDarkThemed?: boolean;
onClick?: () => void;
/**
* Allow body scroll on ios. Changing after mounting has no effect.
* @defaultvalue false
*/
allowIosBodyScroll?: boolean;
}
/**
* {@docCategory Overlay}
*/
export interface IOverlayStyleProps {
/**
* Accept theme prop.
*/
theme: ITheme;
/**
* Accept custom classNames
*/
className?: string;
/**
* Is overlay visible
*/
isNone?: boolean;
/**
* Is overlay dark themed
*/
isDark?: boolean;
}
/**
* {@docCategory Overlay}
*/
export interface IOverlayStyles {
/**
* Style for the root element.
*/
root: IStyle;
}