mirror of
https://github.com/grafana/grafana.git
synced 2024-11-29 20:24:18 -06:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
95 lines
1.8 KiB
Markdown
95 lines
1.8 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "Portal"
|
|
keywords = ["grafana","documentation","sdk","@grafana/ui"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## Portal class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class Portal extends PureComponent<Props>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { Portal } from '@grafana/ui';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>Portal</code> class |
|
|
|
|
<b>Properties</b>
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [node](#node-property) | | <code>HTMLElement</code> | |
|
|
| [portalRoot](#portalroot-property) | | <code>HTMLElement</code> | |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --- | --- | --- |
|
|
| [componentWillUnmount()](#componentwillunmount-method) | | |
|
|
| [render()](#render-method) | | |
|
|
|
|
### constructor(props)
|
|
|
|
Constructs a new instance of the `Portal` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(props: Props);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| props | <code>Props</code> | |
|
|
|
|
### node property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
node: HTMLElement;
|
|
```
|
|
|
|
### portalRoot property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
portalRoot: HTMLElement;
|
|
```
|
|
|
|
### componentWillUnmount method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
componentWillUnmount(): void;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|
|
### render method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
render(): React.ReactPortal;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`React.ReactPortal`
|
|
|