UNPKG

gestalt

Version:

A set of React UI components which enforce Pinterest's design language

23 lines (22 loc) 976 B
import { ReactElement, ReactNode, ReactPortal } from 'react'; import { Indexable } from './zIndex'; type Props = { /** * */ children: ReactNode; /** * An object representing the z-index value of the Layer. See the [z-index example](https://gestalt.pinterest.systems/web/layer#zIndex) for more details. */ zIndex?: Indexable; }; /** * [Layers](https://gestalt.pinterest.systems/web/layer) allow you to render children outside the DOM hierarchy of the parent. It's a wrapper around React createPortal that lets you use it as a component. This is particularly useful for places you might have needed to use z-index to overlay the screen before. * * ![Layer](https://raw.githubusercontent.com/pinterest/gestalt/master/docs/graphics/building-blocks/Layer.svg) */ declare function Layer({ children, zIndex: zIndexIndexable, }: Props): ReactPortal | ReactElement; declare namespace Layer { var displayName: string; } export default Layer;