grafana/docs/sources/packages_api/ui/modalsprovider.md

83 lines
1.8 KiB
Markdown
Raw Normal View History

+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "ModalsProvider"
keywords = ["grafana","documentation","sdk","@grafana/ui"]
type = "docs"
+++
## ModalsProvider class
<b>Signature</b>
```typescript
export declare class ModalsProvider extends React.Component<ModalsProviderProps, ModalsContextState>
```
<b>Import</b>
```typescript
import { ModalsProvider } from '@grafana/ui';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(props)](#constructor-props) | | Constructs a new instance of the <code>ModalsProvider</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [hideModal](#hidemodal-property) | | <code>() =&gt; void</code> | |
| [showModal](#showmodal-property) | | <code>(component: React.ComponentType&lt;any&gt;, props: any) =&gt; void</code> | |
<b>Methods</b>
| Method | Modifiers | Description |
| --- | --- | --- |
| [render()](#render-method) | | |
### constructor(props)
Constructs a new instance of the `ModalsProvider` class
<b>Signature</b>
```typescript
constructor(props: ModalsProviderProps);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| props | <code>ModalsProviderProps</code> | |
### hideModal property
<b>Signature</b>
```typescript
hideModal: () => void;
```
### showModal property
<b>Signature</b>
```typescript
showModal: (component: React.ComponentType<any>, props: any) => void;
```
### render method
<b>Signature</b>
```typescript
render(): JSX.Element;
```
<b>Returns:</b>
`JSX.Element`