UNPKG

@blueprintjs/core

Version:

Core styles & components

github.com/palantir/blueprint

palantir/blueprint

27 lines (19 loc) • 1.24 kB
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
@# Portals The `Portal` component renders its children into a new "subtree" outside of the current component hierarchy. It is essential piece of [`Overlay`](#core/components/overlay), responsible for ensuring that the overlay contents cover the application below. In most cases you do not need to use a `Portal` directly; this documentation is provided simply for reference. @## JavaScript API The `Portal` component is available in the __@blueprintjs/core__ package. Make sure to review the [general usage docs for JS components](#blueprint.usage). The `Portal` component functions like a declarative `appendChild()`, or jQuery's `$.fn.appendTo()`. The children of a `Portal` component are appended to the `<body>` element. `Portal` is used inside [`Overlay`](#core/components/overlay) to actually overlay the content on the application. <div class="pt-callout pt-intent-warning pt-icon-warning-sign"> <h5>A note about responsive layouts</h5> For a single-page app, if the `<body>` is styled with `width: 100%` and `height: 100%`, a `Portal` may take up extra whitespace and cause the window to undesirably scroll. To fix this, instead apply `position: absolute` to the `<body>` tag. </div> @interface IPortalProps