UNPKG

1.7 kBSource Map (JSON)View Raw
1{"version":3,"file":"Overlay.types.js","sourceRoot":"../src/","sources":["components/Overlay/Overlay.types.ts"],"names":[],"mappings":"","sourcesContent":["import * as React from 'react';\nimport type { IStyle, ITheme } from '../../Styling';\nimport type { IRefObject, IStyleFunctionOrObject } from '../../Utilities';\n\n/**\n * {@docCategory Overlay}\n */\nexport interface IOverlay {}\n\n/**\n * {@docCategory Overlay}\n */\nexport interface IOverlayProps extends React.HTMLAttributes<HTMLElement> {\n /**\n * Gets the component ref.\n */\n componentRef?: IRefObject<IOverlay>;\n\n /**\n * Call to provide customized styling that will layer on top of the variant rules\n */\n styles?: IStyleFunctionOrObject<IOverlayStyleProps, IOverlayStyles>;\n\n /**\n * Theme provided by HOC.\n */\n theme?: ITheme;\n\n /**\n * Additional css class to apply to the Overlay\n * @defaultvalue undefined\n */\n className?: string;\n\n /**\n * Whether to use the dark-themed overlay.\n * @defaultvalue false\n */\n isDarkThemed?: boolean;\n\n /**\n * Allow body scroll on touch devices. Changing after mounting has no effect.\n * @defaultvalue false\n */\n allowTouchBodyScroll?: boolean;\n}\n\n/**\n * {@docCategory Overlay}\n */\nexport interface IOverlayStyleProps {\n /**\n * Accept theme prop.\n */\n theme: ITheme;\n\n /**\n * Accept custom classNames\n */\n className?: string;\n\n /**\n * Is overlay visible\n */\n isNone?: boolean;\n\n /**\n * Is overlay dark themed\n */\n isDark?: boolean;\n}\n\n/**\n * {@docCategory Overlay}\n */\nexport interface IOverlayStyles {\n /**\n * Style for the root element.\n */\n root: IStyle;\n}\n"]}
\No newline at end of file