The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/docs/sources/packages_api/ui/portal.md

94 lines
1.8 KiB

+++
# -----------------------------------------------------------------------
# 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`